自动生成接口文档工具-Swagger的使用

出发点

接口文档，方便明确接口名称、参数和类型，能提高开发效率，也方便日后查看和确定某个功能的接口。

我们想找一个工具，方便前端查看接口文档，也方便后端自动生成接口文档。发现swagger有这方面的功能。下面是swagger的使用介绍，和与其他工具的对比。

swagger简介

在后端项目中引入Springfox-swagger，可以扫描相关的代码，生成一个描述文件，进而生成与代码一致的接口文档和客户端代码。这种通过代码生成接口文档的方式，在后面需求持续迭代的项目中，显得很高效。

swagger特点

l 根据接口注释，自动生成接口文档（通过浏览器访问）。

l 在线测试接口。

前端怎么用swagger

请访问示例链接：http://ip地址:端口号/项目名称/swagger-ui.html

l 查看接口名称

l 在Parameters查看请求参数

l 在Example Value查看返回参数

l 测试接口，输入请求参数，点击“Try it out!”

后端怎么用swagger

l 定义接口名称：使用@ApiOperation()和@RequestMapping()标注

l 定义请求参数：使用@RequestBody @ApiParam()标注

l 定义返回参数：使用@ResponseBody标注

l 定义数据模型：使用@ApiModel()标注

不同的项目怎么访问swagger

访问路径：http://ip地址:端口号/项目名称/swagger-ui.html。所以多个项目，会有多个访问路径。

作者：dengChaoJie

链接：https://juejin.im/post/5db930d8f265da4cfc695a6c

来源：掘金

著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。