Swagger注解-@ApiParam

骑猪看日落 2022-02-14 06:17 374阅读 0赞

# 使用场景 #

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

# 概述 #

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

# 属性 #

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