这是我参与更文挑战的第1天，活动详情查看： 更文挑战
前后端分离开发模式中，api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。
- 及时性（接口变更后，能够及时准确的通知前后端开发人员）
- 规范性（并且保证接口的规范性，如接口的地址，请求方式，参数，响应格式和错误信息）
- 一致性（接口信息一致，不糊出现文档版本不一致产生分歧）
- 可测性（直接在接口文档上进行测试）
1、依赖：
2、配置类：
3、配置config
3.1 API模型
entity的实体类中可以添加一些自定义设置，例如：
3.2 定义接口说明和参数说明
- @Api：修饰整个类，描述Controller的作用
- @ApiOperation：描述一个类的一个方法，或者说一个接口
- @ApiParam：单个参数描述
- @ApiModel：用对象来接收参数
- @ApiProperty：用对象接收参数时，描述对象的一个字段
- @ApiResponse：HTTP响应其中1个描述
- @ApiResponses：HTTP响应整体描述
- @ApiIgnore：使用该注解忽略这个API
- @ApiError ：发生错误返回的信息
- @ApiImplicitParam：描述一个请求参数，可以配置参数的中文含义，还可以给参数设置默认值
- @ApiImplicitParams：描述由多个 @ApiImplicitParam 注解的参数组成的请求参数列表
版权声明：
本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。
本文网址：https://www.mushiming.com/mjsbk/6911.html