Swagger注解-@Api

时间会告诉你答案，但不能重来 时间会告诉你答案，但不能重来 博客等级 墨衍会员 · AI 创作全网分发 墨衍智能分发 本文由作者通过墨衍一键同步至各平台 1分发平台 5.6k累计阅读 5.6k平均单平台 已同步平台 优快云 微信公众号 微博 知乎 掘金 百家号 博客园 抖音 小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年，写一次发全网 我也要 码龄9年
关注
原创 最新推荐文章于 2026-08-05 15:25:06 发布 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万+

【多模态融合】TransFusion学习笔记(1)

工作上主要还是以纯lidar的算法开发,部署以及系统架构设计为主。对于多模态融合(这里主要是只指Lidar和Camer的融合)这方面研究甚少。最近借助和朋友们讨论论文的契机接触了一下这方面的知识，起步是晚了一点，但好歹是开了个头。下面就借助TransFusion论文及其开源代码来串一串这方面的知识。这个很好理解，参考FPointNet网络图示。就是利用现有的2D检测器在图像上提取2D初始框，根据Camera成像原理，捕获2D框视锥内的点云，再利用点云分类模型(如:PointNet)做进一步分类。

4961

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

RI-CLPM vs CLPM：什么时候该用随机截距交叉滞后模型？

本文深入对比了交叉滞后模型（CLPM）与随机截距交叉滞后模型（RI-CLPM）的核心差异与应用场景。RI-CLPM通过分离个体间稳定特质与个体内动态波动，能更纯净地估计变量间的动态因果关系，避免CLPM可能存在的混淆。文章提供了清晰的模型选择决策框架，并辅以Mplus语法示例，帮助研究者根据变量特质稳定性与研究问题，正确选用模型以确保结论的严谨性。

weixin_29276847的博客 303

告别Keil？在Mac上配置STM32CubeIDE + CMSIS-DAP调试器全攻略（含常见报错解决）

本文详细介绍了在Mac平台上配置STM32CubeIDE与CMSIS-DAP调试器的全流程，包括硬件准备、软件安装、工程创建及调试优化。通过实战指南，帮助开发者高效完成STM32开发，解决常见报错问题，提升开发效率。

weixin_30485379的博客 433

Swagger API 注解说明

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

haotian_guo的博客 2339

【Unity终极奥义】Unity打包去掉启动画面Logo，无需破解，一学就会

大家都知道Unity打包的应用在启动的时候都会有一个默认的UnityLogo。 而且这个Logo使用升级版和破解版都是可以随意清除和更换的。 但是Unity个人版是无法通过Unity的打包设置去进行更换的。 那今天就教大家一个使用个人普通版更换Unity启动画面Logo的方法！一起来看一下吧！

努力前行，总会成为自己心中的那道光 8万+

swagger2注解学习@Api

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

WorldMvp的专栏 715

Python 爬虫实战：淘宝直播间实时数据抓取（弹幕分析 + 流量监控）

随着电商直播的迅猛发展，淘宝直播已成为品牌推广和商品销售的重要阵地。通过爬取淘宝直播间的实时数据，包括弹幕互动和流量信息，可以帮助商家深入了解用户行为、优化直播策略，同时为市场分析和商业决策提供数据支持。本文将深入探讨如何利用 Python 爬虫技术实现对淘宝直播间实时数据的抓取，并进行弹幕分析和流量监控。

u014481728的博客 729

斗鱼直播间弹幕爬虫实战：WebSocket连接与实时数据采集

在数据驱动的时代，直播平台的弹幕数据蕴含着巨大的价值——用户行为分析、舆情监控、弹幕情感分析、直播热度评估等应用场景层出不穷。斗鱼作为国内领先的直播平台，其弹幕系统基于WebSocket协议实现实时双向通信。本文将带您从零开始，使用Python构建一个完整的斗鱼直播间弹幕爬虫系统。

2201_76125261的博客 136

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

KEPServerEX 6 之驱动协议（UDD）实战 HTTP协议对接OpenWeatherMap天气 API全流程指南

本文分享了基于 KEPServerEX 6 的通用设备驱动(UDD)对接OpenWeatherMap天气API的实战方案。该方案针对工业物联网场景进行了深度优化，具有动态城市切换、运行时热配置、老旧JS引擎兼容等核心特性。文章详细介绍了从环境准备、脚本部署到Tag配置的全流程，重点解析了Legacy JS语法适配、Float类型安全处理等关键实现细节，并提供了完整的避坑指南和故障排查方法。该方案经过生产环境验证，可稳定实现气象数据采集与动态切换功能，适用于SCADA/MES系统集成场景。

-雲飛兄-博客 712

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

@Api @ApiOperation @ApiModel @ApiModelProperty Swagger 注解

global_coding的博客 4287

NTscan扫描工具

ntscan是一个扫描器，可以扫描没有密码和弱密码的共享，先到配置文件中填写猜测的用户名和密码，扫描过程中右侧出现的是扫描日志。

ssm框架搭建

这个是一个在idea上成功跑起来的ssm框架项目，保存在这里方便以后使用直接下载

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

霍尼韦尔SoftMaster使用说明

霍尼韦尔SoftMaster使用说明

Swagger中@Api注解踩坑记录

转自。

weixin_39514020的博客 486

pscad IEEE标准系统搭建说明

pscad IEEE标准系统搭建说明，包含典型的IEEE 9节点、14节点、30节点、39节点和118节点系统。内含标准测试系统的原始数据和潮流结果。

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、付费专栏及课程。

余额充值