swagger如何使用

1、第一步

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步

2、第二步

为什么用Swagger

特征：是一个服务；可视化；契约测试（前后端面分离）；同步性，及时协商，尽早解决

3、第三步

Swagger配置

满足两个条件：能从服务端拿到接口信息数据和正常访问index.html文件

4、第四步

使用说明

@ApiOperation(value=“接口说明”,httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”；)

5、第五步

swagger扩展，Swagger个性化

例：支持集合说明，自定义注解