swagger2 相关注解使用

一、简介：

swagger2可以通过在代码里添加注解自动生成接口文档。

它可以将项目的所有接口在一个UI界面上展示出来，同时表明了这个接口的用途，接口需要的参数是什么类型参数是否必须，输入了参数可以直接测试接口类似postman的功能，会显示接口请求的状态码和返回的数据结构。

二、优点：

1. 大大减少前后端的沟通
2. 方便查找和测试接口
3. 提高团队的开发效率
4. 方便新人了解项目

三、相关注解：

1、@Api：请求类的说明
2、@ApiOperation：方法的说明
3、@ApiImplicitParams、@ApiImplicitParam：方法参数的说明
4、@ApiResponses、@ApiResponse：方法返回值的状态码说明
5、@ApiModel：用于JavaBean上面，表示对JavaBean 的功能描述
                5.1、当请求数据描述时， `@RequestBody` 时的使用
                5.2、@ApiModelProperty：用在JavaBean类的属性上面，说明属性的含义

四、注解使用：

参见：https://blog.youkuaiyun.com/xiaojin21cen/article/details/78654652