Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam

墨蓝 2022-02-14 06:19 2022阅读 0赞

# @ApiImplicitParams #

## 使用场景 ##

在 Rest 接口方法上使用来指定请求参数

## 概述 ##

在 Rest 接口方法上使用来指定请求参数

## 属性 ##

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>ApiImplicitParam[]</td> 
   <td></td> 
   <td>API 可用的参数列表</td> 
  </tr> 
 </tbody> 
</table>

# @ApiImplicitParam #

## 使用场景 ##

### 场景一：在 Rest 接口上单独使用 ###

@ApiImplicitParam 在 Rest 接口上单独使用的时候，表示单个请求参数

### 场景二：在 Rest 接口上和 @ApiImplicitParams 组合使用 ###

@ApiImplicitParam 在 Rest 接口上和 @ApiImplicitParams 组合时候，表示多个请求参数

## 概述 ##

表示 Rest 接口的单个请求参数，可与 @ApiImplicitParams 组合使用来表示多个请求参数

## 属性 ##

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>参数名称(实体类字段名称)</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.SwaggerSpecFilte</td> 
  </tr> 
  <tr> 
   <td>allowMultiple</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>指定参数是否可以通过多次出现来接收多个值</td> 
  </tr> 
  <tr> 
   <td>dataType</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>参数的数据类型，可以使类名或原始数据类型</td> 
  </tr> 
  <tr> 
   <td>dataTypeClass</td> 
   <td>Class&lt;?&gt;</td> 
   <td>Void.class</td> 
   <td>参数的类，如果提供则覆盖 dataType</td> 
  </tr> 
  <tr> 
   <td>paramType</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>参数的参数类型，有效值为 path, query, body, header, form</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>参数示例，仅适用于 BodyParameters(请求体类型的)</td> 
  </tr> 
  <tr> 
   <td>type</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>添加覆盖检测到的类型的功能</td> 
  </tr> 
  <tr> 
   <td>format</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>添加提供自定义格式的功能</td> 
  </tr> 
  <tr> 
   <td>allowEmptyValue</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>添加将 format 设置为空的功能</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>