Swagger 常用注解说明

悠悠 2022-06-02 07:20 293阅读 0赞

# Swagger 常用注解说明 #

<table> 
 <thead> 
  <tr> 
   <th><strong>注解</strong></th> 
   <th><strong>属性</strong></th> 
   <th><strong>值</strong></th> 
   <th><strong>备注</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>@Api</code></td> 
   <td>value</td> 
   <td>字符串</td> 
   <td>可用在<code>class</code>头上,<code>class</code>描述</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>description</td> 
   <td>字符串</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@Api(value = "xxx", description = "xxx")</code></td> 
  </tr> 
  <tr> 
   <td><code>@ApiOperation</code></td> 
   <td>value</td> 
   <td>字符串</td> 
   <td>可用在方法头上.参数的描述容器</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>notes</td> 
   <td>字符串</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>httpMethod</td> 
   <td>字符串</td> 
   <td>请求方法</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@ApiOperation(value = "xxx", notes = "xxx", method = "GET")</code></td> 
  </tr> 
  <tr> 
   <td><code>@ApiImplicitParams</code></td> 
   <td>{}</td> 
   <td><code>@ApiImplicitParam</code>数组</td> 
   <td>可用在方法头上.参数的描述容器</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@ApiImplicitParams({@ApiImplicitParam1,@ApiImplicitParam2,...})</code></td> 
  </tr> 
  <tr> 
   <td><code>@ApiImplicitParam</code></td> 
   <td>name</td> 
   <td>字符串 与参数命名对应</td> 
   <td>可用在<code>@ApiImplicitParams</code>里</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>value</td> 
   <td>字符串</td> 
   <td>参数中文描述</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>required</td> 
   <td>布尔值</td> 
   <td>true/false</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>dataType</td> 
   <td>字符串</td> 
   <td>参数类型</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>paramType</td> 
   <td>字符串</td> 
   <td>参数请求方式:query/path</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td>query:对应<code>@RequestParam</code>传递</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td>path: 对应<code>@PathVariable</code>{}path传递</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>dataType</td> 
   <td>字符串</td> 
   <td>参数类型</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>dataTypeClass</td> 
   <td>类</td> 
   <td>参数对应的类</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>defaultValue</td> 
   <td>字符串</td> 
   <td>在api测试中默认值</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@ApiImplicitParam(name = "newProduct", value = "商品信息对象", required = true, dataType = "Product", dataTypeClass = Product.class)</code></td> 
  </tr> 
  <tr> 
   <td><code>@ApiResponses</code></td> 
   <td>{}</td> 
   <td><code>@ApiResponse</code>数组</td> 
   <td>可用在方法头上.参数的描述容器</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@ApiResponses({@ApiResponse1,@ApiResponse2,...})</code></td> 
  </tr> 
  <tr> 
   <td><code>@ApiResponse</code></td> 
   <td>code</td> 
   <td>整形</td> 
   <td>可用在<code>@ApiResponses</code>里</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>message</td> 
   <td>字符串</td> 
   <td>错误描述</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>response</td> 
   <td>类</td> 
   <td>返回结果对应的类</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@ApiResponse(code = 200, message = "Successful", response = CommonResponse.class)</code></td> 
  </tr> 
  <tr> 
   <td><code>@ApiModelProperty</code></td> 
   <td>name</td> 
   <td>字符串</td> 
   <td>实体类参数名称</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>value</td> 
   <td>字符串</td> 
   <td>实体类参数值</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>notes</td> 
   <td>字符串</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td><code>@ApiModelProperty(name = "name", value = "name", notes = "名称")</code></td> 
  </tr> 
 </tbody> 
</table>