swagger2常用注解使用

版权声明：有不足之处欢迎指出，欢迎交流 https://blog.csdn.net/qq_33594101/article/details/84797771

swagger2常用注解使用

• @Api()用于类；
  表示标识这个类是swagger的资源
• @ApiOperation()用于方法；
  表示一个http请求的操作
• @ApiParam()用于方法，参数，字段说明；
  表示对参数的添加元数据（说明或是否必填等）
• @ApiModel()用于类
  表示对类进行说明，用于参数用实体类接收
• @ApiModelProperty()用于方法，字段
  表示对model属性的说明或者数据操作更改
• @ApiIgnore()用于类，方法，方法参数
  表示这个方法或者类被忽略
• @ApiImplicitParam() 用于方法
  表示单独的请求参数
• @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

---

1. Api()用于类

---

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
value	url的路径值
basePath	基本路径可以不配置
position	如果配置多个Api 想改变显示的顺序位置
produces	For example, “application/json, application/xml”
consumes	For example, “application/json, application/xml”
protocols	Possible values: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为true 将在文档中隐藏

2. ApiOperation()用于方法

---

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
basePath	基本路径可以不配置
position	如果配置多个Api 想改变显示的顺序位置
produces	For example, “application/json, application/xml”
consumes	For example, “application/json, application/xml”
protocols	Possible values: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为true 将在文档中隐藏
response	返回的对象
responseContainer	这些对象是有效的 “List”, “Set” or “Map”.，其他无效
httpMethod	“GET”, “HEAD”, “POST”, “PUT”, “DELETE”, “OPTIONS” and “PATCH”
code	http的状态码 默认 200
extensions	扩展属性

3. ApiParam()用于方法，参数，字段说明；

---

属性名称	备注
name	属性名称
value	属性值
defaultValue	默认属性值
allowableValues	可以不配置
required	是否属性必填
access	不过多描述
allowMultiple	默认为false
hidden	隐藏该属性
example	举例子

4. ApiModel()用于类

---

属性名称	备注
value	属性值
description	描述

5. ApiModelProperty()用于方法，字段

---

属性名称	备注
value	字段说明
name	重写属性名字
dataType	重写属性类型
required	是否必填
example	举例说明
hidden	隐藏(注:作用于实体类属性没用)

6. ApiIgnore()用于类，方法，方法参数

---

属性名称	备注
value	属性值

7. ApiImplicitParam() 用于方法

---

属性名称	备注
paramType	参数放在哪个地方
name	参数代表的含义
dataType	参数类型，有String/int，无用
required	是否必要
defaultValue	参数的默认值

8. ApiImplicitParams() 用于方法，包含多个@ApiImplicitParam