Swagger2
Remember_Ray
有天你会让我妒忌的.
展开
-
Swagger2构建RESTful (一)
我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTful API文档来记录所有接口细节,然而这样的做法有以下几个问题:由于接口众多,并且细节复杂(需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等),高质量地创建这份文档本身就...原创 2018-07-01 13:12:20 · 3454 阅读 · 0 评论 -
Swagger2构建RESTful (二)
Swagger注释API详细说明说明:作用范围API使用位置对象属性@ApiModelProperty用在出入参数对象的字段上协议集描述@Api用于controller类上协议描述@ApiOperation用在controller的方法上Response集@ApiResponses用在controller的方法上Response@ApiResponse用在 @ApiResponses里边非对象参数...原创 2018-07-01 13:15:52 · 490 阅读 · 0 评论 -
Swagger2构建RESTful (三)
使用Swagger2Markup实现API文档的静态部署Swagger2Markup简介Swagger2Markup是Github上的一个开源项目。该项目主要用来将Swagger自动生成的文档转换成几种流行的格式以便于静态部署和使用,比如:AsciiDoc、Markdown、Confluence。项目主页:https://github.com/Swagger2Markup/swagger2mark...原创 2018-07-01 17:20:12 · 681 阅读 · 0 评论