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

CRaxsRat v7.6 安装与使用教程（附工具下载）

摘要：本文介绍远程管理工具CRaxsRat v7.6的合法应用与基本操作，强调仅限授权环境使用。该工具支持多客户端管理、TLS加密及文件/进程控制等功能，适用于内网维护与安全测试。安装需Windows 10/11系统及.NET 4.8，步骤包括解压运行、配置监听端口及生成客户端。文中提醒防火墙设置与杀软误报问题，并重申禁止非法用途，建议在虚拟机或隔离环境学习使用。

lzj781210的博客 3791

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

实战指南 | 利用TSMaster的C小程序实时监控DBC报文发送周期

本文提供了一份利用TSMaster的C小程序实时监控DBC报文发送周期的实战指南。通过创建用户变量、编写C小程序核心逻辑并关联图形模块，工程师可以直观地可视化关键报文（如ID 0x64）的发送间隔，从而快速发现周期异常，提升汽车电子开发和测试中总线问题定位的效率与实时性。

weixin_29178069的博客 417

Android 以太网802.1x 配置

802.1X认证网络配置摘要：本文介绍了通过wpa_supplicant.conf文件配置802.1X企业网络认证的两种方法：PEAP-MSCHAPv2方式和TLS方式。PEAP方式需设置SSID、用户名、密码，可选择是否验证CA证书；TLS方式则需要配置客户端证书、私钥及CA证书路径。文件配置完成后需设置权限并重启设备。最后提出如何验证802.1X配置是否生效的问题，但未给出具体验证方法。该配置适用于需要802.1X认证的企业网络环境。

zhaoyufei133的博客 458

Swagger API 注解说明

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

haotian_guo的博客 2339

ubuntu20.4源码安装最新gcc（gcc V12.2）

Ubuntu20.4自带的gcc为V9.4.0的版本，老版本的gcc存在不支持新版本C语言规范，在配置、编译、安装应用软件或工具时，可能存在不能正确安装的问题。（比如：libpqxx-7.7.4在配置时要求c++17版本的支持，但gcc V9.4.0版本不支持c++17）。因此本文介绍ubuntu20.4的系统下载最新gcc12.2版本源码，并进行本地编译、安装。本节内容包括gcc12.2的必备库安装和gcc12.2安装两部分内容组成。

q544344318的博客 1万+

swagger2注解学习@Api

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

WorldMvp的专栏 715

三菱CNC数据采集实战：从环境搭建到代码实现的完整指南

本文提供了一份完整的三菱CNC数据采集实战指南，涵盖从开发环境搭建、核心SDK获取、网络配置到基于C#和A2协议的完整代码实现。文章详细解析了初始化、连接管理、数据获取与展示四大核心模块，并分享了错误处理、性能优化及与MES系统集成的关键技巧，帮助工程师快速构建稳定可靠的工业数据采集系统。

wood5的博客 889

从零到一：Zephyr RTOS 在 STM32F4 上的移植与实战（含设备树配置详解）

本文详细介绍了如何从零开始将Zephyr RTOS移植到STM32F4开发板，涵盖开发环境搭建、硬件抽象层分析、设备树配置及系统裁剪等关键步骤。通过实战案例，帮助开发者掌握Zephyr RTOS在嵌入式设备中的应用，提升物联网边缘计算设备的开发效率。

weixin_26976635的博客 590

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

基于物联网技术智慧园林绿化养护管理信息平台

近几年来，随着经济不断的发展，城市面积不断的扩大，城市管理中的园林绿化工作也在这种趋势下不断的发生着深刻改变。管养企业是否按制定的管养计划严格执行?绿化事件整改是否及时到位?绿地面积是否在稳步增长?管养的效果如何?如何客观评价管养企业的管养工作?这些都是我们各级管理者需要面对的问题。 　　智慧园林绿化养护管理信息平台的开发思路以“考核”为核心，整个信息平台体现出“新、快、高、全、享”五个特点。 　　智慧园林绿化养护管理信息平台的整个开发理念为：依托五大技术手段(全球卫星定位系统技术、地理信...

Cesium的博客QQ2252224326 2459

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

@Api @ApiOperation @ApiModel @ApiModelProperty Swagger 注解

global_coding的博客 4287

Kindle电子书DRM破解全攻略：从下载到转换的完整流程（含最新DeDRM插件配置）

本文详细介绍了如何合法移除个人购买的Kindle电子书的DRM保护，实现跨设备阅读与备份。核心内容包括使用最新DeDRM插件（如noDRM分支）配合Calibre进行配置，并针对亚马逊最新的KFX加密格式提供了密钥提取与实战操作指南。文章强调该方法仅适用于个人合理使用，旨在帮助读者真正掌控自己的数字资产。

delta的博客 576

android 蓝牙通讯demo

android 下蓝牙通讯demo，实现了发现蓝牙，使能蓝牙，通过蓝牙发送消息。

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

OV9734 DATASHEET，完整规格书

OV9734完整规格书，包括电气参数，尺寸规格，寄存器配置表等

Swagger中@Api注解踩坑记录

转自。

weixin_39514020的博客 486

假人有限元模型

假人模型，车辆碰撞假人有限元模型，适合做乘员安全的研究者利用

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

余额充值