Swagger注解-@Api

时间会告诉你答案，但不能重来 时间会告诉你答案，但不能重来 博客等级 墨衍会员 · AI 创作全网分发 墨衍智能分发 本文由作者通过墨衍一键同步至各平台 1分发平台 5.6k累计阅读 5.6k平均单平台 已同步平台 优快云 微信公众号 微博 知乎 掘金 百家号 博客园 抖音 小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年，写一次发全网 我也要 码龄9年
关注
原创 最新推荐文章于 2026-06-05 16:58:58 发布 5.6k 阅读 AI 写同款· GEO 优化 ›
Swagger-Api超详细教程 Api接口测试文档 阅读详情

Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址

使用场景

在 Rest 接口类上边使用。

概述

标记类为 Swagger 资源类，运行时有效。

属性

属性名称数据类型默认值说明
valueString“”隐式设置操作的标记，遗留支持(读取 description)
tagsString[]“”对接口进行分组
producesString“”采用逗号分隔的 content types,例如:application/json,application/xml 生成JSON和XML的输出
consumesString“”采用逗号分隔的 content types，例如: application/json,application/xml 会接收JSON和XML的输入
protocolsString“”采用逗号分隔的可用协议，例如:http,https,ws,wss
authorizationsAuthorization[]“”授权列表
hiddenbooleanfalse隐藏此资源下的操作, 和 @ApiOperation 注解中的 hidden 组合使用可以隐藏改接口

Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址

收录于
Swagger

当前文章被收录于：

Swagger
12 篇文章 4 人学习

1. Swagger 使用； 2. Swagger 注解； 3. Swagger 与其它框架集成。

订阅专栏 查看详情
swagger注解

当前文章被收录于：

swagger注解
11 篇文章 12 人学习
订阅专栏 查看详情
标签
#Swagger #Swagger注解 #@Api
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
swagger注解之@ApiOperation swagger注解之@ApiOperation @ApiOperation() 用于方法；表示一个http请求的操作 @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”）；其他参数可参考源码； value：对该操作进行简单的描述，尽量控制在120字符以内。 notes：对操作的详细描述。 httpMethod：指定操作使用的HTTP方法类型，可选值 “GET”、“HEAD” 阅读详情

相关推荐

RuoYi项目里用Swagger注解的正确姿势：从@Api到@ApiModelProperty的实战避坑指南

本文深入探讨了在RuoYi企业级开发框架中正确使用Swagger注解的方法，从基础标注到复杂场景的避坑指南。详细解析了@Api、@ApiModelProperty等注解在RuoYi项目中的特殊适配技巧，包括控制器层标注、方法级注解与AjaxResult的配合，以及文件上传和接口安全的文档化处理。帮助开发者高效生成规范的API接口文档，提升团队协作效率。

weixin_31240035的博客 236

Swagger常见注解@API、@ApiOperation、@ApiParam等

Swagger2一些常用注解 最近遇到了一个使用swagger来生成接口文档的项目，在controller看到了一些没用过的注解（@API、@ApiOperation等），遂记录一下 @API使用在类上，表明是swagger资源 拥有两个属性:value、tags，源码如下 //If tags is not used,this value will be used to set the tag...

瓜皮康的博客 10万+

二、租用AutoDL服务器与连接教程

点击右上角控制台，选择【租用新的实例】；，我这里使用的是xshell和xftp工具（自行下载）。打开本地目录和服务器目录，直接拖动文件。

zzf021122的博客 1326

swagger @Api @ApiOperation @ApiImplicitParams @ApiResponses @ApiModel @ApiModelProperty 基本使用总结

一般controller上@Api(value="标题",tags="标签一",description="描述")publicclassxxxxxxxxxxxController{@Api用在总的controller上方value即名称，也可以默认不写value，默认会给与value例如@Api("标题")tags即对api的分类，类似于接口的标签用于进一步分类description即对接口的描述一般接口上如下示例对当前具体接口的描述，......

weixin_44131922的博客 4573

从业10年的AI应用架构师：企业AI平台运营的4个核心经验，值得收藏

去年年底，我在某大型制造企业做AI咨询时，遇到了这样的场景：这不是个例。我接触过的10家企业中，有7家的AI平台都陷入了“技术自嗨”的陷阱——技术团队追求模型精度、功能完备性，却忽略了业务到底需要什么。如果你也遇到过类似问题：比如“模型准确率很高，但业务不买账”“AI项目上线后没人用”“投入产出比极低”，那么这篇文章的4个经验，可能会帮你避开这些坑。很多企业认为，AI平台就是“买一套工具+部署几个模型”。但实际上，企业AI平台的本质是“技术与业务的连接生态”：根据Gartner的报告，80%的企业AI项目失

AI 原生应用开发的博客 709

STM32G4实战：用CubeMX+Keil五分钟搞定FreeRTOS多任务LED控制（避坑指南）

本文详细介绍了如何在STM32G4系列芯片上使用CubeMX和Keil快速配置FreeRTOS实现多任务LED控制，包括环境准备、时钟配置、任务创建及常见问题解决方案。重点解决了时钟源冲突等高频问题，并提供了优化建议和进阶应用示例，帮助开发者高效完成嵌入式开发任务。

joy55的博客 222

Swagger API 注解说明

用于描述 API 操作方法可能出现的错误情况，不过在一些常见的 Swagger 版本（如基于 Springfox 实现的 Swagger）中，可能并没有直接使用这个注解来描述错误情况，更多的是通过。方法上，清晰地说明了每个方法的具体功能，如 “获取所有用户信息” 和 “根据用户 ID 获取特定用户信息”，这些描述会在 Swagger UI 中对应方法的展示区域显示出来。：用于描述一个具体的 API 操作方法，通常标注在控制器类中的方法上，用来详细说明该方法所实现的功能。表示这些属性在该模型中是必需的。

haotian_guo的博客 2339

SE (3) -Transformers：三维旋转 - 平移等变注意力网络

E (3) 变换器，这是一种用于三维点云和图的自注意力模块变体，在连续三维旋转平移下具有等变性。注意力机制的计算量会随着点云规模的增大呈二次方增长，因此引入邻域的概念是很有必要的：每个点不再关注所有其他点，而只关注其最近的邻点。注意力机制此前已在图的领域中以内部注意力、自注意力、顶点注意力或图注意力等名称被引入 [17, 31, 32, 12, 26]。等变性意味着当输入数据发生旋转或平移时，模型的输出也会以相应的、可预测的方式进行变换，从而保证模型性能的稳定性和可预测性。

qq_49786473的博客 1480

swagger2注解学习@Api

一、swagger简介 Swagger是目前最好用的Restful API文档生成的开源项目。通过swagger-spring项目，其实现了与SpingMVC框架的无缝集成功能，方便生成spring restful风格的接口文档。同时，swagger-ui还具有测试spring restful风格的接口的功能。 swagger官方网站为：http://swagger.io/ swagger中...

WorldMvp的专栏 715

从零搭建风电场：手把手教你用WAsP+WindPRO完成风资源评估全流程

本文详细介绍了从零开始搭建风电场的全流程，重点讲解如何使用WAsP和WindPRO进行风资源评估和风场布局优化。内容包括软件配置、数据采集规范、风图谱建模实战、机组选型策略以及常见问题解决方案，帮助工程师掌握风电开发的核心技术，提升项目成功率。

year5的博客 371

流媒体弱网优化之路(NACK)——纯NACK方案的优化探索

流媒体学习之路(NACK)——纯NACK方案的最高性能 文章目录流媒体学习之路(NACK)——纯NACK方案的最高性能一、NACK简介二、Nack的理解2.1 一种补救策略2.2 什么时候要？2.3 要多少？2.4 怎么要？三、计算分析3.1 rtt强相关3.2 补包次数计算3.3 Nack的定时发送3.4 nack重传限制四、实验   近期在针对纯丢包场景做一些简单的探索实验，一个让我困扰的问题就是：不使用FEC而只是通过纯NACK进行补偿，到底能在实验环境下抵抗多少的丢包呢？每一次丢包补偿的最大时长

qw225967的博客 1万+

swagger2常用注解说明@Api

https://blog.youkuaiyun.com/u014231523/article/details/76522486说明： 1.这里使用的版本：springfox-swagger2（2.4）springfox-swagger-ui （2.4） 2.这里是说明常用注解的含义和基本用法（也就是说已经对swagger进行集成完成） 没有集成的请参见 SpringBoot集成springfox-sw...

qq_32534441的博客 3696

pip——【Fatal error in launcher: Unable to create process】的深度排查与修复指南

本文深度解析了Python包管理工具pip报错【Fatal error in launcher: Unable to create process】的根本原因与解决方案。该错误通常由Python解释器路径变更、虚拟环境损坏或多版本冲突导致。文章提供了从快速排查到彻底修复的完整指南，包括使用`python -m pip`命令绕过启动器、修复或重装pip、重建虚拟环境等核心方法，并给出了预防此错误的最佳实践。

weixin_29306261的博客 598

@Api @ApiOperation @ApiModel @ApiModelProperty——Swagger常用注解

@Api @ApiOperation @ApiModel @ApiModelProperty Swagger 注解

global_coding的博客 4287

全网最强AI辅助课题申报教程！超详细流程拆解，助你快速提高课题申报成功率（附各部分高效提示词）

实验法要详细说明自变量、因变量、实验类型、实验过程、实验步骤、测量工具名称、被试取样方式、无关变量控制方法。这个部分就是让评审专家相信我们有能力把这个项目干成，写的时候要重点突出两块内容：第一是研究基础，包括你或团队在相关领域已有的研究成果，比如发表的论文、承担过的课题、获得过的奖励、相关研究经验等，要具体、有说服力；课题申报专门给我们留了一小节用来突出课题的创新之处，不管是研究角度、研究对象、研究方法，还是应用价值都可以提炼作为我们的创新点，最后的语气成果也要明确具体，且要和课题内容紧密相关。

智能AI让学术科研更容易 665

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。，新界面，新视觉，

Swagger常见注解@API、@ApiOperation、@ApiParam

Swagger2一些常用注解 最近遇到了一个使用swagger来生成接口文档的项目，在controller看到了一些没用过的注解（@API、@ApiOperation等），遂记录一下 @API 使用在类上，表明是swagger资源，@API拥有两个属性:value、tags，源码如下 //If tags is not used,this value will be used to set the tag for the operations described by this resource. Othe

weixin_57763462的博客 2414

visio安装包

Microsoft Office Visio 是一款专业的制图软件。利用经过更新的形状、协作工具和数据链接图表，创建专业级图表以简化复杂的信息。

Swagger中@Api注解踩坑记录

转自。

weixin_39514020的博客 486

SAP B1中文培訓教材_SDK

公司内部培训资料，对开发工具 ，DIAPI， UIAPI，Add-ON有详细解说

Camera2Demo

在Camera2 的基础上进行封装，使得Camera2一堆初始化逻辑与Activity分离，降低耦合度，完成预览拍照并保存的操作

swagger注解@Api不生效的问题

我目前的项目，有个类Swagger2Config.java 在这里面配置了扫描的包的路径，如果包路径不在范围内，那么swagger的注解，是不会被扫描到的！

asdfghjklor的博客 1万+

常用Swagger注解汇总

在实际编写后端代码的过程中，我们可能经常使用到 swagger 注解，但是会用不代表了解，你知道每个注解都有什么属性吗？你都用过这些属性吗？了解它们的作用吗？本文在此带大家总结一下常用的swagger注解，供大家学习理解。

莪是男神的博客 4727

swagger api的@Api以及@ApiImplicitParam注解详解

原文地址：https://www.cnblogs.com/caiwx/p/11132163.html @Api：用在请求的类上，表示对类的说明 tags=“说明该类的作用，可以在UI界面上看到的注解” value=“该参数没什么意义，在UI界面上也看到，所以不需要配置” @ApiOperation：用在请求的方法上，说明方法的用途、作用 value=“说明方法的用途、作用” notes=“方法的备注说明” @ApiImplicitParams：用在请求的方法上，表示一组参数说明 @ApiImplicitPa

季白之二七的博客 1753

Swagger注解

@API详细说明 @ApiImplicitParam

天马行空的创作中心 2523

Swagger(二) Swagger信息配置与常用注解

Swagger信息配置与常用注解 一、 Swagger 配置 可以在项目中创建 SwaggerConfig，进行配置文档内容。 1 配置基本信息 Docket：摘要对象，通过对象配置描述文件的信息。 apiInfo:设置描述文件中 info。参数类型 ApiInfo select():返回 ApiSelectorBuilder 对象，通过对象调用 build()可以 创建 Docket 对象 ApiInfoBuilder：ApiInfo 构建器。 @Configuration pub..

奥迪的博客 7581

swagger配置及注解详解

swagger配置及注解详解 1.加入依赖的jar包 <!--引入swagger的依赖--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </depe

qq_39082353的博客 5361

Swagger注解 传参

[@Api] @ Api用于声明Swagger资源API。 它有双重用途 - 它会 影响资源列表_和_ API声明。 只有使用@ Api注释的类才会被Swagger扫描。 在资源清单中，注释将转换为[资源对象] 在API声明中，它基本上将作为[API声明]本身的基础。 JAX-RS的用法是: @Api(tags = "区域：/area", description = "地区的增删查改...

shan317500的博客 6256

swagger注解

swagger常用注解

qq_39940489的博客 798
上一篇： CentOS 7 安装 Python 3.7.3
下一篇： Swagger注解-@ExternalDocs
点赞 1
评论 2
书签 书签 19
时间会告诉你答案，但不能重来
时间会告诉你答案，但不能重来
博客等级 码龄9年 91粉丝 146原创
+ 关注 专栏目录 订阅专栏
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值