Swagger注解-@ApiOperation

淩亂°似流年 2022-02-14 06:17 957阅读 0赞

# 使用场景 #

在 Rest 接口上使用

# 概述 #

描述针对特定路径的操作，通常是 HTTP 方法。具有等效路径的操作被分到单个分组中。HTTP 方法和路径的组合创建了一个独特的操作

# 属性 #

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td></td> 
   <td>接口简要说明，120字符或更少</td> 
  </tr> 
  <tr> 
   <td>notes</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>接口详细描述</td> 
  </tr> 
  <tr> 
   <td>tags</td> 
   <td>String[]</td> 
   <td>“”</td> 
   <td>tag 列表，可用于按自愿或任何其它限定符对操作进行逻辑分组</td> 
  </tr> 
  <tr> 
   <td>response</td> 
   <td>Class&lt;?&gt;</td> 
   <td>Void.class</td> 
   <td>接口返回类型</td> 
  </tr> 
  <tr> 
   <td>responseContainer</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>声明包装响应的容器。有效值为 List,Set,Map，任何其它值都将被忽略</td> 
  </tr> 
  <tr> 
   <td>responseReference</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>指定对响应类型的引用，本地/远程引用，并将覆盖任何其它指定的response()类</td> 
  </tr> 
  <tr> 
   <td>httpMethod</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>请求方式:“GET”, “HEAD”, “POST”, “PUT”, “DELETE”, “OPTIONS” and “PATCH”,如果未指定则使用除"PATH"之外的其它所有</td> 
  </tr> 
  <tr> 
   <td>nickname</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>第三方工具使用operationId来唯一表示此操作</td> 
  </tr> 
  <tr> 
   <td>produces</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>采用逗号分隔的 content types 类型的返回数据，例如:application/json,application/xml</td> 
  </tr> 
  <tr> 
   <td>consumes</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>采用逗号分隔的 content types 类型的入参数据类型，例如:application/json,application/xml</td> 
  </tr> 
  <tr> 
   <td>protocols</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>指定协议类型:http,https,ws,wss,多个协议使用逗号进行分隔</td> 
  </tr> 
  <tr> 
   <td>authorizations</td> 
   <td>Authorization[]</td> 
   <td>@Authorization(value = “”)</td> 
   <td>获取此操作的授权列表</td> 
  </tr> 
  <tr> 
   <td>hidden</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>是否隐藏操作列表中的操作</td> 
  </tr> 
  <tr> 
   <td>responseHeaders</td> 
   <td>ResponseHeader[]</td> 
   <td>@ResponseHeader(name = “”, response = Void.class)</td> 
   <td>指定 response header 信息列表</td> 
  </tr> 
  <tr> 
   <td>code</td> 
   <td>int</td> 
   <td>200</td> 
   <td><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html" rel="nofollow">HTTP返回状态码</a></td> 
  </tr> 
  <tr> 
   <td>extensions</td> 
   <td>Extension[]</td> 
   <td>@Extension(properties = @ExtensionProperty(name = “”, value = “”))</td> 
   <td>可选的扩展数组</td> 
  </tr> 
 </tbody> 
</table>