Swagger注解-@ApiParam

使用场景

在 Rest 接口上或 Rest 接口参数前边使用

概述

为 Rest 接口参数添加其它元数据(导入到 yapi 中不会被解析)

属性

属性名称	数据类型	默认值	说明
name	String	“”	参数名称，参数名称将从 filed/method/parameter 名称中派生，但你可以覆盖它，路径参数必须始终命名为它们所代表的路径部分
value	String	“”	参数简单描述
defaultValue	String	“”	描述参数默认值
allowableValues	String	“”	可接收参数值限制，有三种方式,取值列表，取值范围
required	boolean	false	是否为必传参数, false:非必传; true:必传
access	String	“”	参数过滤，请参阅:io.swagger.core.filter.SwaggerSpecFilter
allowMultiple	boolean	false	指定参数是否可以通过多次出现来接收多个值
hidden	boolean	false	隐藏参数列表中的参数
example	String	“”	非请求体(body)类型的单个参数示例
examples	Example	@Example(value = @ExampleProperty(mediaType = “”, value = “”))	参数示例，仅适用于请求体类型的请求
type	String	“”	添加覆盖检测到类型的功能
format	String	“”	添加提供自定义format格式的功能
allowEmptyValue	boolean	false	添加将格式设置为空的功能
readOnly	boolean	false	添加被指定为只读的能力
collectionFormat	String	“”	添加使用 array 类型覆盖 collectionFormat 的功能