Swagger注解记录

注解名称

描述

常用属性

@Api

用于类，标识这个类是Swagger的资源

tags：给该类下的接口设置标签

@Tag

可用于类或方法，声明一个标签

name：标签名称
description：标签描述

@ApiIgnore

忽略该类的文档生成

value：添加备注

@ApiOperation

用于方法，用于描述一个HTTP请求方法

value：给方法添加描述

@ApiParam

用于参数，用于描述请求参数

value：参数描述
name：参数名称
defaultValue：参数默认值
required：参数是否必填
allowableValues：参数允许范围
type：参数类型

@ApiImplicitParam

代表一个单个API操作，与@ApiImplicitParams联用

paramType：参数请求类型
dataTypeClass：参数值类型
其他类型同@ApiParam

@ApiImplicitParams

多个@ApiImplicitParam注解的集合

参数为@ApiImplicitParam数组

@ApiModel

用于类，声明一个Swagger的模型

value：模型名称
description：模型描述

@ApiProperty

用于参数，声明Swagger模型的属性或填充数据

value：属性描述
name：属性名称
allowableValues：允许值

@ApiResponse

用于描述一个可能的返回结果

responseCode：返回状态码
message：返回信息

@ApiResponses

@ApiResponse的集合

参数为@ApiResponse数组