Swagger注解-@ApiModel 和 @ApiModelProperty

灰太狼 2022-02-14 06:19 381阅读 0赞

# @ApiModel #

## 使用场景 ##

在实体类上边使用，标记类时swagger的解析类

## 概述 ##

提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省

## 属性 ##

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td>类名</td> 
   <td>为模型提供备用名称</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>提供详细的类描述</td> 
  </tr> 
  <tr> 
   <td>parent</td> 
   <td>Class&lt;?&gt; parent</td> 
   <td>Void.class</td> 
   <td>为模型提供父类以允许描述继承关系</td> 
  </tr> 
  <tr> 
   <td>discriminatory</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型</td> 
  </tr> 
  <tr> 
   <td>subTypes</td> 
   <td>Class&lt;?&gt;[]</td> 
   <td>{}</td> 
   <td>从此模型继承的子类型数组</td> 
  </tr> 
  <tr> 
   <td>reference</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>指定对应类型定义的引用，覆盖指定的任何其他元数据</td> 
  </tr> 
 </tbody> 
</table>

# @ApiModelProperty #

## 使用场景 ##

使用在被 @ApiModel 注解的模型类的属性上

## 概述 ##

添加和操作模型属性的数据

## 属性 ##

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>属性简要说明</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>运行覆盖属性的名称。重写属性名称</td> 
  </tr> 
  <tr> 
   <td>allowableValues</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>限制参数可接收的值，三种方法，固定取值，固定范围</td> 
  </tr> 
  <tr> 
   <td>access</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>过滤属性，参阅:io.swagger.core.filter.SwaggerSpecFilter</td> 
  </tr> 
  <tr> 
   <td>notes</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>目前尚未使用</td> 
  </tr> 
  <tr> 
   <td>dataType</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>position</td> 
   <td>int</td> 
   <td>0</td> 
   <td>允许在模型中显示排序属性</td> 
  </tr> 
  <tr> 
   <td>hidden</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>隐藏模型属性，false:不隐藏; true:隐藏</td> 
  </tr> 
  <tr> 
   <td>example</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>属性的示例值</td> 
  </tr> 
  <tr> 
   <td>readOnly</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>指定模型属性为只读，false:非只读; true:只读</td> 
  </tr> 
  <tr> 
   <td>reference</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>指定对应类型定义的引用，覆盖指定的任何其他元数据</td> 
  </tr> 
  <tr> 
   <td>allowEmptyValue</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>允许传空值，false:不允许传空值; true:允许传空值</td> 
  </tr> 
 </tbody> 
</table>