Swagger注解-@Api

绝地灬酷狼 2022-02-14 06:13 312阅读 0赞

# 使用场景 #

在 Rest 接口类上边使用。

# 概述 #

标记类为 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>隐式设置操作的标记，<em><strong>遗留支持</strong></em>(读取 description)</td> 
  </tr> 
  <tr> 
   <td>tags</td> 
   <td>String[]</td> 
   <td>“”</td> 
   <td>对接口进行分组</td> 
  </tr> 
  <tr> 
   <td>produces</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>采用逗号分隔的 content types,例如:application/json,application/xml 生成JSON和XML的输出</td> 
  </tr> 
  <tr> 
   <td>consumes</td> 
   <td>String</td> 
   <td>“”</td> 
   <td>采用逗号分隔的 content types，例如: application/json,application/xml 会接收JSON和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>“”</td> 
   <td>授权列表</td> 
  </tr> 
  <tr> 
   <td>hidden</td> 
   <td>boolean</td> 
   <td>false</td> 
   <td>隐藏此资源下的操作, 和 @ApiOperation 注解中的 hidden 组合使用可以隐藏改接口</td> 
  </tr> 
 </tbody> 
</table>

发表评论取消回复

表情：

评论列表（有 0 条评论，312人围观）

还没有评论，来说两句吧...

相关阅读

相关 Swagger注解

Swagger是一个开源的API文档工具，可以自动生成API文档，方便开发人员查看和调用API接口。在Java开发中，我们可以使用Swagger注解来描述API接口和参数，从而

短命女/ 2024年03月16日 18:34/ 0 赞/ 18 阅读

相关 swagger注解。

类注解 @Api（类注解） value > > 表示类的链接地址，访问此类的URL中需要加/，必填。 > > > > des

曾经终败给现在/ 2024年02月18日 17:33/ 0 赞/ 5 阅读

相关 Swagger注解

@API详细说明 ![这里写图片描述][70] @ApiImplicitParam ![这里写图片描述][70 1] [70]: /images/202205

傷城~/ 2022年05月22日 07:37/ 0 赞/ 263 阅读

相关 Swagger注解-@ResponseHeader

使用场景作为 @ApiResponse 的属性，作为返回数据的一部分，指定返回 header 信息概述作为返回数据的一部分提供返回数据的 header 信息

た入场券/ 2022年02月14日 06:17/ 0 赞/ 554 阅读

相关 Swagger注解-@ApiOperation

使用场景在 Rest 接口上使用概述描述针对特定路径的操作，通常是 HTTP 方法。具有等效路径的操作被分到单个分组中。HTTP 方法和路径的组合创建了一个

淩亂°似流年/ 2022年02月14日 06:17/ 0 赞/ 896 阅读

相关 Swagger注解-@ApiParam

使用场景在 Rest 接口上或 Rest 接口参数前边使用概述为 Rest 接口参数添加其它元数据(导入到 yapi 中不会被解析) 属性 <tab

骑猪看日落/ 2022年02月14日 06:17/ 0 赞/ 300 阅读

相关 Swagger注解-@SwaggerDefinition

使用场景定义 metadata level 时使用，在 Rest 接口或类上使用概述配置定义 metadata level的注解。仍然缺少 Security

秒速五厘米/ 2022年02月14日 06:15/ 0 赞/ 395 阅读

相关 Swagger注解-@ExternalDocs

使用场景使用外部文档说明的时候使用，参数，方法，属性上可使用概述定义外部文档说明属性 <table> <thead> <tr>

た入场券/ 2022年02月14日 06:13/ 0 赞/ 315 阅读

相关 Swagger注解-@Api

使用场景在 Rest 接口类上边使用。概述标记类为 Swagger 资源类，运行时有效。属性 <table> <thead> <tr>

绝地灬酷狼/ 2022年02月14日 06:13/ 0 赞/ 313 阅读

相关 Swagger注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 @Api：修饰整个类，描述Controller的作用

短命女/ 2021年10月18日 22:46/ 0 赞/ 470 阅读