swagger2是通过扫描很多的注解来获取数据帮我们展示在ui界面上的,下面就介绍下常用的注解。
1. @Api()
用在请求的类上,表示对类的说明,也代表了这个类是swagger2的资源
参数:
- tags:说明该类的作用,参数是个数组,可以填多个
- value:该参数没什么意义,在UI界面上不显示,所以不用配置
- description:用户基本信息描述
2. @ApiOperation()
用于方法,表示一个http请求访问该方法的操作
参数:
- value:方法的用途和作用
- notes:方法的注意事项和备注
- httpMethod:请求方式
3. @ApiModel()
用于响应实体类上,用于说明实体作用
参数:
- description:描述实体的作用
4. @ApiModelProperty
用在属性上,描述实体类的属性
参数:
- value:描述参数的意义
- name:参数的变量名
- required:参数是否必选
5. @ApiImplicitParams
用在请求的方法上,包含多@ApiImplicitParam
6. @ApiImplicitParam
用于方法,表示单独的请求参数
参数:
- name:参数名称
- value:参数说明
- dataType:数据类型
- paramType:表示参数放在哪里
- defaultValue:参数的默认值
- required:表示参数是否必须传
7. @ApiParam()
用于方法,参数,字段说明 表示对参数的要求和说明
参数:
- name:参数名称
- value:参数的简要说明
- defaultValue:参数默认值
- required:表示属性是否必填,默认为false
8. @ApiResponses
用于请求的方法上,根据响应码表示不同响应,一个@ApiResponses包含多个@ApiResponse
9. @ApiResponse
用在请求的方法上,表示不同的响应
参数:
- code:表示响应码(int型),可自定义
- message:状态码对应的响应信息"
10. @ApiIgnore()
用于类或者方法上,不被显示在页面上
11. @Profile({“dev”, “test”})
用于配置类上,表示只对开发和测试环境有用