SpringBoot + Swagger 2 & 3

value

url 的路径值

tags

该类的作用

produces

对 Api 资源的描述

consumes

如, “application/json, application/xml”

protocols

协议类型，如: http, https, ws, wss.

authorizations

高级特性认证时配置

hidden

配置为 true ，将在文档中隐藏

value

说明方法的作用

notes

方法的备注说明

tags

tag 列表，可用于按自愿或任何其它限定符对操作进行逻辑分组

response

接口返回类型

responseContainer

声明包装响应的容器。有效值为 List,Set,Map，任何其它值都将被忽略

responseReference

指定对响应类型的引用，本地/远程引用，并将覆盖任何其它指定的 response()类

httpMethod

请求方式:“GET”, “HEAD”, “POST”, “PUT”, “DELETE”, “OPTIONS” and “PATCH”,如果未指定则使用除"PATH"之外的其它所有

nickname

第三方工具使用 operationId 来唯一表示此操作

produces

采用逗号分隔的 content types 类型的返回数据，例如:application/json,application/xml

consumes

采用逗号分隔的 content types 类型的入参数据类型，例如:application/json,application/xml

protocols

指定协议类型:http,https,ws,wss,多个协议使用逗号进行分隔

authorizations

获取此操作的授权列表

hidden

是否隐藏操作列表中的操作

responseHeaders

指定 response header 信息列表

code

HTTP 返回状态码

extensions

可选的扩展数组

ignoreJsonView

value

API 可用的参数列表（@ApiImplicitParam）

name

参数名称(实体类字段名称)

value

参数简要说明

defaultValue

描述参数的默认值

allowableValues

限制此参数接收的值，可使用的值或值得范围

required

指定是否为必填参数,false:非必传参数; true:必传参数

access

参数过滤，参考: io.swagger.core.filter.SwaggerSpecFilte

allowMultiple

指定参数是否可以通过多次出现来接收多个值

dataType

参数的数据类型，可以使类名或原始数据类型

dataTypeClass

参数的类，如果提供则覆盖 dataType

paramType

参数的参数类型，有效值为 path, query, body, header, form

example

非请求体(body)参数的单个请求示例

examples

参数示例，仅适用于 BodyParameters(请求体类型的)

type

添加覆盖检测到的类型的功能

format

添加提供自定义格式的功能

allowEmptyValue

添加将 format 设置为空的功能

readOnly

添加被指定为只读的能力

collectionFormat

添加使用 array 类型 collectionFormat 的功能

name

参数名称，参数名称将从 filed/method/parameter 名称中派生，但你可以覆盖它，路径参数必须始终命名为它们所代表的路径部分

value

参数简单描述

defaultValue

描述参数默认值

allowableValues

可接收参数值限制，有三种方式,取值列表，取值范围

required

是否为必传参数, false:非必传; true:必传

access

参数过滤，请参阅:io.swagger.core.filter.SwaggerSpecFilter

allowMultiple

指定参数是否可以通过多次出现来接收多个值

hidden

隐藏参数列表中的参数

example

非请求体(body)类型的单个参数示例

examples

参数示例，仅适用于请求体类型的请求

type

添加覆盖检测到的类型的功能

format

添加提供自定义 format 格式的功能

allowEmptyValue

添加将格式设置为空的功能

readOnly

添加被指定为只读的能力

collectionFormat

添加使用 array 类型 collectionFormat 的功能

value

为模型提供备用名称

description

提供详细的类描述

parent

为模型提供父类以允许描述继承关系

discriminator

支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型

subTypes

从此模型继承的子类型数组

reference

指定对应类型定义的引用，覆盖指定的任何其他元数据

value

属性简要说明

name

运行覆盖属性的名称。重写属性名称

allowableValues

限制参数可接收的值，三种方法，固定取值，固定范围

access

过滤属性，参阅:io.swagger.core.filter.SwaggerSpecFilter

notes

目前尚未使用

dataType

参数的数据类型，可以是类名或原始数据类型，此值将覆盖从类属性读取的数据类型

required

是否为必传参数,false:非必传参数; true:必传参数

position

允许在模型中显示排序属性

hidden

隐藏模型属性，false:不隐藏; true:隐藏

example

属性的示例值

accessMode

reference

指定对应类型定义的引用，覆盖指定的任何其他元数据

allowEmptyValue

允许传空值，false:不允许传空值; true:允许传空值

extensions

value

ApiResponse 列表

code

响应的 HTTP 状态码

message

伴随响应的人类可读的消息

response

用于描述消息有效负载的可选响应类，对应于响应消息对象的 schema 字段

reference

指定对响应类型的引用，指定的应用可以使本地引用，也可以是远程引用，将按原样使用，并将覆盖任何指定的 response()类

responseHeaders

可能响应的 header 列表

responseContainer

声明响应的容器，有效值为 List,Set,Map，任何其他值都将被忽略

examples