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万+

OGG故障指南：OGG-01163 Bad column length (xxx) specified for column

OGG-01163 Bad column length (xxx) specified for column AAA in table OWNER.TABLE, maximum allowable length is yyy

qqqyyy0422的博客 717

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

ThingsBoard入门实战（七）：公共发布和 UI 细节修改

公共发布和 UI 细节修改7.细节修改和公共发布一、公共发布二、UI优化下载运行修改三、下一步还可以做什么？更好的UI更丰富的系统模块 7.细节修改和公共发布 GET到新技能了，想给兄弟们演示，需要给他们每个人一个账号么？ 答案肯定是：不需要！ ThingsBoard 用 公共发布 解决了这个问题。 一、公共发布 首先我们来看一下路灯设备现在在谁名下？ 如下图，路灯都是customerA的， 目前只有它和它的租户可以看到，其他人需要看就需要设为公有。 如图操作： 对于设备详情仪表盘，我们也需要设为公有

AIGC搞起 9118

绕过卡巴斯基通过RPC控制lsass注入DLL

参考国外的XPN以及3gstudent大佬的文章： https://blog.youkuaiyun.com/xiangshen1990/article/details/104872566 https://gist.github.com/xpn/93f2b75bf086baf2c388b2ddd50fb5d0 原理：正常的ssp扩展（dll）可以加载到lsass进程中去，比如kerberos验证都是通...

2ed 3524

Swagger API 注解说明

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

haotian_guo的博客 2339

Weaxor勒索病毒实战分析：从加密算法到防御策略（附检测工具清单）

本文对Weaxor勒索病毒进行了深度实战剖析，详细拆解了其采用ChaCha20与AES-CTR的混合加密算法、横向移动手法及数据回传行为。文章重点分析了其密钥生成机制的“漏洞修复”，并提供了从主机加固、网络监控到基于IOC威胁狩猎的立体化企业级防御策略与检测工具清单。

weixin_29233333的博客 262

swagger2注解学习@Api

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

WorldMvp的专栏 715

基于非接触式微波雷达设计的睡眠监控系统_323

本项目设计了一种基于非接触式微波雷达的睡眠监控系统，通过高精度的生理信号采集与分析，帮助用户全面了解自身的睡眠状态和健康状况。系统采用60GHz频段的R60ABD1毫米波雷达模块，实现对人体呼吸频率、心率、活动状态、体动幅度等参数的非接触式测量；结合MLX90614红外体温传感器，能够实时监测人体体温。此外，系统通过蜂鸣器报警和数据上云功能，及时向用户反馈异常生理指标，确保健康风险早期预警。数据通过ESP8266-WIFI模块上传至华为云物联网平台，用户可通过Android手机APP和Windows上位机远

499

第十二天：Python字典(Dict)详解

字典(Dictionary)是Python中最强大的数据类型之一，它是一种可变的、无序的键值对(key-value)集合。字典中的元素是通过键(key)来存取的，而不是通过偏移量(如列表中的索引)。 字典的核心特性包括： 键值对结构：每个元素由一个键和一个值组成，中间用冒号(:)分隔 无序性：字典中的元素没有固定的顺序(Python 3.7+版本中字典会保持插入顺序，但不应依赖此特性进行顺序操作) 可变性：可以动态地添加、修改或删除键值对 键的唯一性：字典中的键必须是唯一的，如果重复，后面的键值对会覆盖

本博客聚焦 YOLOv11 全流程落地，涵盖架构优化、数据集处理、训练技巧与多场景部署，兼及国产数据库、Java 开发与 AI 模型应用，内容兼顾理论与工程实践，为开发者提供系统干货，助力高效提升技术能力。 1677

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

SAP RAP 校验全流程：从 EML 读取到消息上屏与阻止落库

本文系统梳理了 SAP ABAP RAP 中的校验流程（The Validation Process），结合 Airline/Connection 案例，详细讲解了三类核心校验：语义键唯一性、外键有效性和字段间一致性。文章覆盖了 EML 的 READ ENTITIES 操作、reported-* 与 failed-* 结构的使用方法、消息创建与字段绑定技巧，以及处理草稿数据时的 UNION 查询策略。通过代码示例演示了如何实现校验逻辑、生成错误消息并阻止无效数据持久化，同时提供了常见问题的排查建议。全文注重

2007 年 ~ 2025 年，深耕 SAP 技术 18 年 332

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

@Api @ApiOperation @ApiModel @ApiModelProperty Swagger 注解

global_coding的博客 4287

YOLOv11改进 | 添加注意力篇 | 一文带你改进GAM、CBAM、CA、ECA等通道注意力机制和多头注意力机制

这篇文章给大家带来的改进机制是一个汇总篇，包含一些简单的注意力机制，本来一直不想发这些内容的（网上教程太多了，发出来增加文章数量也没什么意义），但是群内的读者很多都问我这些机制所以单独出一期视频来汇总一些比较简单的注意力机制添加的方法和使用教程，本文的内容不会过度的去解释原理，更多的是从从代码的使用上和实用的角度出发去写这篇教程。欢迎大家订阅我的专栏一起学习YOLO！YOLOv11改进系列专栏——本专栏持续复习各种顶会内容——科研必备目录一、本文介绍二、GAM2.1 GAM的介绍2.2 GAM的核心代码。

Snu77的博客 5152

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术，以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索，主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式，计算机控制系统的数学描述与基本分析方法，以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

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

pscad IEEE标准系统搭建说明

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

Swagger中@Api注解踩坑记录

转自。

weixin_39514020的博客 486

Camera2Demo

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

大中型超市收银系统(可直接运行)

光步前台收银系统系统功能：商品销售、商品退货、挂单、收银员权限、会员销售、单品取消、整单取消、商品查询、脱机销售、脱机数据上传，基本资料下载，开钱箱、小票打印、收款结算，支持多币种付款方式（现金、储值卡、礼券、微信等）,支持多种促销。运行环境：.net 4.0登陆信息用户名:1001 密码:123456内置商品信息，商品编码可输入00001000 - 00010000,测试效果相关功能键F5 结算 F9挂单 F11商品查询 F8退货 Insert单品取消 Del整单取消 F12开钱箱F2 会员 Ctrl+Z退出系统 Home 锁屏 相关源码待公开

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

余额充值