常用注解
Swagger的所有注解定义在io.swagger.annotations包下,常用注解如下:
注解
说明
用于controller类上
@Api(tags = “xxx模块说明”)
作用在类上
tags="说明该类的作用"
value="该参数没什么意义,所以不需要配置"
用于方法上面(说明参数的含义)
@ApiOperation(“xxx接口说明”)
作用在接口方法上
value用于方法描述
notes用于提示内容,接口描述
tags可以重新分组(视情况而用,一般不建议使用)
@ApiImplicitParam()
@ApiImplicitParams()
用于方法,包含多个 @ApiImplicitParam
用于方法上面(返回参数或对象的说明)
@ApiResponse
用于指定单个参数的说明
方法返回值的说明
code:数字,例如400
message:信息,例如"请求参数没填好"
response:响应参数描述类
注明:如果使用的3.0版本,
需要增加配置:
springfox.documentation.swagger.use-model-v3=false
@ApiResponses
包含多个@ApiResponse
对象类
@ApiModel(“xxxPOJO说明”)
作用在模型类上:如VO、BO
value–表示对象名
description–描述都可省略
@ApiModelProperty(value = “xxx属性说明”,hidden = true)
作用在类方法和属性上
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiParam(“xxx参数说明”)
用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等)
name–参数名
value–参数说明
required–是否必填
其它
@ApiIgnore()
用于类,方法,方法参数,表示这个方法或者类被忽略