目录
1 Swagger介绍
Swagger是最流行的API开发工具,它遵循OpenAPI Specification(OpenAPI规范,简称OAS)。Swagger可以贯穿于整个API生态,如API的设计、编写API文档、测试和部署。
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
1.1 Swagger应用场景
- 如果你的RESTful API接口都开发完成了,可以用Swagger-editor来编写API 文档(yaml文件或json文件),然后通过Swagger-ui来渲染该文件,展现API文档。
- 如果你的RESTful API还未开始,也可以使用Swagger生态,来设计和规范你的API,以Annotation(注解)的方式给你的源代码添加额外的元数据。这样Swagger就可以检测到这些元数据,自动生成对应的API描述信息。Swagger 支持自动生成 API 文档。
1.2 Swagger作用
- 接口的文档在线自动生成。
- 功能测试。
2 Swagger注解说明
(1)@Api:用在类上,说明该类的作用。
(2)@ApiOperation:给API增加方法说明。
(3)@ApiImplicitParams : 用在方法上包含多个参数说明。
(4)@ApiImplicitParam&#x