Swagger 3 已经发布了一段时间了,但是这里我们主要学习目前更主流的 Swagger 2。
Swagger 2 整体注解
- Swagger 2 请求类注解,主要用于 Controller 类上
- Swagger 2 请求方法注解,主要用于 Controller 类对应的方法上
- Swagger 2 对象类注解,主要用于 JavaBean 上
1、Swagger 2 请求类注解
- @Api 标识 Swagger 识别的类
- @Api 放在 @Controller 注解并列的请求类上
- 核心参数包含 value、tags、description
@Api():用在请求的类上,表示对类的说明,也代表了这个类是 swagger2 的资源,参数:
- tags:接口说明,可以在页面中显示。可以配置多个,当配置多个的时候,在页面中会显示多个接口的信息。
- value - 字段说明
- description - 注释说明这个类
2、Swagger 2 请求方法注解
- @ApiOperation 标识 Swagger 识别的方法
- @ApiImplicitParam 标识方法的参数的说明
- @ApiResponse 标识方法返回值的说明