Swagger注解-@ApiResponses 和 @ApiResponse

原创 最新推荐文章于 2026-09-04 15:47:12 发布 7.7w 阅读 AI写同款
收录于
Swagger

当前文章被收录于：

Swagger
12 篇文章 4 人学习

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

订阅专栏 查看详情
swagger注解

当前文章被收录于：

swagger注解
11 篇文章 12 人学习
订阅专栏 查看详情
时间会告诉你答案，但不能重来
时间会告诉你答案，但不能重来 博客等级 码龄9年 墨衍会员 · AI 创作全网分发 墨衍智能分发 本文由作者通过墨衍一键同步至各平台 1分发平台 7.7w累计阅读 7.7w+平均单平台 已同步平台 优快云 微信公众号 微博 知乎 掘金 百家号 博客园 抖音 小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年，写一次发全网 我也要
91粉丝146篇原创
关注
Springboot部分注解说明（功能+使用介绍） @Api(tags = " ")@Api用于请求类上，表示对类的说明@ApiOperation 用在请求的方法上，说明方法的用途、作用@ApiResponses:用在请求的方法上，表示一组响应@ApiResponse：用在@ApiResponses中，一般用于表达一个错误或正确的影像信息@ApiModel:用于响应类上，表示一个返回响应数据的信息 @GetMapping是Spring4.3提供给的新注解，它是一个组合注解，等价于@RequestMapping(method=RequestMethod.Get 阅读详情
AI摘要

本文深入讲解Swagger注解的使用，包括@ApiOperation、@ApiResponses、@ApiResponse等，旨在帮助开发者更好地理解和运用这些注解，提升RESTful 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 地址

@ApiResponses

代码示例

github 代码示例： https://github.com/CoderFreeMan/swagger-demo

使用场景

在 Rest 接口上使用，用作返回值的描述

概述

一个包装器，允许列出多个 ApiResponse，若果你需要描述单个 ApiResponse，你仍然必须使用此注解并将@ApiResponse 包装在一个数组中

属性

属性名称数据类型默认值说明
valueApiResponse[]ApiResponse 列表

@ApiResponse

使用场景

在 Rest 接口或类上和 @ApiResponses 组合使用，组装返回参数说明

概述

描述操作的可能响应，这可用于描述 Rest API 调用中可能的成功和错误 code 码。此注解可以在方法或类级别应用；仅当在方法级别或抛出时未定义相同代码的@ApiResponse注解时才会解析类级别注解异常，如果响应中使用了不同的响应类，则可以通过将响应类于响应码组合使用。注意swagger不允许单个响应代码的多个响应类型。此注解不直接使用，单独使用时swagger不会解析，应该和ApiResponses组合使用。

属性

属性名称数据类型默认值说明
codeint响应的HTTP状态码
messageString伴随响应的人类可读的消息
responseClass<?>Void.class用于描述消息有效负载的可选响应类，对应于响应消息对象的 schema 字段
referenceString“”指定对响应类型的引用，指定的应用可以使本地引用，也可以是远程引用，将按原样使用，并将覆盖任何指定的response()类
responseHeadersResponseHeader[]@ResponseHeader(name = “”, response = Void.class)可能响应的 header 列表
responseContainerString“”声明响应的容器，有效值为List,Set,Map，任何其他值都将被忽略

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注解 #@ApiResponses #@ApiResponse
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
二，接口文档管理工具-swagger注解使用 ApiResponse：HTTP响应其中1个描述。@ApiResponses：HTTP响应整体描述。@ApiIgnore：使用该注解忽略这个API。@ApiError ：发生错误返回的信息。swagger参考demo。swagger相关注解介绍。 阅读详情

相关推荐

ApiResponse response = *.class不起作用

此处添加了ApiResponse注解，但在swagger中的响应依然没有数据 目录 一、原因分析 二、解决办法 （1）创建一个泛型实体类 （2）编写一个测试接口 三、再次访问Swagger接口 一、原因分析 AjaxResult是继承的map，Swagger只认识定义好的类-属性，所以接口返回Map,对于Swagger来说是没有字段展示的。 二、解决办法 如需要可以使用泛型类R<T>来解决这个问题。 （1）创建一个泛型实体类 packag...

猿小白的博客 1985

@ApiResponses、@ApiResponse、@ApiImplicitParams、ApiImplicitParam

@ApiImplicitParam： 作用在方法上，表示单独的请求参数  参数：  1. name ：参数名。  2. value ： 参数的具体意义，作用。  3. required ： 参数是否必填。  4. dataType ：参数的数据类型。  5. paramType ：查询参数类型，这里有几种形式： 类型 作用 path 以地址的形式提交数据 query ...

qq_36826506的博客 5万+

轻松构建RESTful API：Spring @ResponseBody注解全攻略，有两下子！

🏆本文收录于《滚雪球学Spring Boot》，专门攻坚指数提升，2025 年国内最系统+最强（更新中）。    本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习，可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内，快速投入学习！！两不误。

**My Coding Family** 1080

@ApiResponses

@ApiResponses：用于表示一组响应 @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息 code：数字，例如400 message：信息，例如”请求参数没填好” response：抛出异常的类

qq_42360413的博客 9484

手把手教你搭建一个属于自己的网站-适合零基础小白，文末附网站模板

手把手教你搭建一个属于自己的网站-适合零基础小白写在前面搭建需求功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入 写在前面 前段时间休息想着搭一个属于自己的网站，几经尝试终于成功了，网上其实有很多教程，但很多，希望这篇文章能够帮助到

qq_46788925的博客 1万+

Allegro File菜单实战指南：从导入网表到导出BOM的完整流程

PCB设计离不开对EDA软件菜单体系的深入理解。在Cadence Allegro中，File菜单是数据流转的中枢，它不仅是新建、打开、保存的基础入口，更是连接原理图与版图、设计与制造的关键桥梁。工程师常遇到的“导入网表报错”“导出BOM为空”“板框不闭合”等高频问题，大多源于对File菜单中Import与Export功能的理解不到位。从基础概念出发，先厘清Import（网表、DXF、IPC）与Export（BOM、ODB++、DXF）的工作原理，再结合版本兼容、封装库路径、单位设置等工程细节，即可构建完整的

weixin_32950759的博客 295

Swagger给返回参数添加注释说明

处理效果 第一步,控制层加上注解 @ApiResponses({ @ApiResponse(code = 200,message = "OK",response = TrainUserTEntity.class), }) 第二步,实体类属性上面加上注解 @ApiModelProperty(value = "姓名", required = true) ...

qq_25983579的博客 5万+

ABAP传输自定义IDOC实例

首先确定出站方和入站方，本例中我使用150作为发送方将200作为接收方。 发送端系统配置 进入tcode-SALE，点击定义逻辑系统，这里我定义D01CLNT150为发送端， D01CLNT200为接收端 2，将逻辑系统分配给对应的client 3，进入tcode-WE31，创建IDOC开发段（segment）这里可以按照实际需求创建想要传输的结构，为求简单我创建了ZKNA1并选取了几个客户主数据的字段作为示例 4，进入tcode-WE30，创建Idoc Ty...

Nathan的博客 4077

swagger注解类说明

讲解内容 swagger常用到的注解的解释 SpringMvc中控制层类中使用这些注解 swagger常用到的注解的解释 在pom.xml文件中添加包依赖：swagger-annotations-1.5.10.jar 所有注解： 常用到的注解有： Api ApiModel ApiModelProperty ApiOperation ApiParam ApiResponse...

顾丽江的专栏 4114

Cursor集成Claude 4.6免费版：本地IDE合规调用指南

大语言模型编程助手（LLM Copilot）已成为现代开发标配，其核心能力依赖于上下文理解、代码推理与结构化输出等关键技术原理。Anthropic官方提供的Claude系列模型，尤其Claude 4.6，凭借200K超长上下文、tool use函数调用和严格可控的API设计，在工程实践中展现出显著技术价值。该能力可无缝嵌入本地IDE环境，支撑代码解释、跨文件分析、单元测试生成等高频开发场景。本文聚焦Cursor这一开源可审计IDE，详解如何合规复用Anthropic免费tier接口（/v1/messages

weixin_34095889的博客 537

保姆级教程：用Kalibr搞定Intel D435i三目（RGB+双目）相机联合标定，附完整ROSbag录制避坑指南

本文详细介绍了如何使用Kalibr工具对Intel D435i三目相机（RGB+双目）进行高精度联合标定，包括硬件准备、ROSbag录制技巧、Kalibr标定实战及结果验证。特别针对实际工程中的常见问题提供了解决方案，帮助开发者提升SLAM和三维重建等应用的精度。

weixin_42524762的博客 405

Swagger基本配置及常用注解

配置扫描接口 在创建Docket对象时，可以通过select()方法来配置如何扫描接口。 可以用一个词来概括—>层层细化 @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.

qq_36917119的博客 2644

数据预处理之数据平滑处理#matlab

介绍基于 MATLAB 的数据平滑方法，主要介绍 smooth 函数、smoothts 函数和 medfilt1 函数的用法。

m0_56619132的博客 2415

swagger常用注解说明

常用到的注解有： Api ApiModel ApiModelProperty ApiOperation ApiParam ApiResponse ApiResponses ResponseHeader 1. api标记 Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源，使用方式： @Api(value = “/user”, description = “Operations about user”) 与Controller注解并列使用。 属性配置： 属性名称

qq_37786939的博客 368

如何利用gretna软件计算脑网络全局属性(聚类系数，小世界属性，最短路径)，局部属性指标（度，度分布，节点效率），如何理解网络稀疏度

grena工具箱被设计用于fMRI数据的图论网络分析。它是一套MATLAB函数和基于MATLAB的接口，用于常规的fMRI预处理，用于计算和统计分析最常用的网络指标，如小世界参数、效率、度、间性、关联性、层级性、同步性和模块化。......

从事脑科学核磁共振方法学研究，在Nature communications等权威期刊发表研究论文，熟练掌握磁共振处理方法和统计学方法，欢迎大家和我交流。 9174

【Unity 实用工具篇】✨| 受击插件Feel 详细教程，开发游戏时更好的操控 游戏打击感

在一个游戏中，游戏手感对于游戏的整体游玩体验是非常重要的，而游戏手感中有一个很重要的点：打击感 那本篇文章就来讲一下打击感中的受击反馈部分。 在游戏中经常会用到攻击敌人，敌人扣血，执行某些受击功能的执行，尤其是对于有战斗场景的游戏来说，这就是标准的受击反馈。 所以引出本篇文章的主角：受击插件 Feel 的使用，2D和3D游戏都可以使用。

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

swagger 常用注解

哈哈哈 自己也不知道 swagger 但是知道在项目中怎么用 哈哈 1.常用注解 1、与模型相关的注 两个注解： @ApiModel：用在模型类上，对模型类做注释； @ApiModelProperty：用在属性上，对属性做注释 2、与接口相关的注解 六个注解： @Api：用在controller上，对controller进行注释； @ApiOpera...

aocheqing0591的博客 786

LinePhone3.2.7(android端最新版本) sip客户端

SIP客户端For android：LinePhone3.2.7(最新版本)，官网地址：http://www.linphone.org/

Swagger 常用注解使用详解

转载简书：https://www.jianshu.com/p/12f4394462d5   swagger常用标识主要有以下几种： 1、@Api @Api主要在类上使用，说明该类作用。可以标识一个controller类作为swagger文档资源来使用。与controller注解同时使用。 @Api(value = "/user", description = "Operations a...

sunspun的博客 458

pscad IEEE标准系统搭建说明

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

efm32 入门.pdf

本PDF共计22页，介绍的是操作驱动API，下载与否自己斟酌。

swagger常用注解

一、swagger常用注解 1、与模型相关的注解 两个注解： @ApiModel：用在模型类上，对模型类做注释； @ApiModelProperty：用在属性上，对属性做注释 2、与接口相关的注解 六个注解： @Api：用在controller上，对controller进行注释； @ApiOperation：用在API方法上，对该API做注释，说明API的作用；

u013291972的博客 1万+

SIMATIC S7-1200, S7-1500 PID 控制[手册]

SIMATIC S7-1200, S7-1500 PID 控制[手册]

swagger常用注释API总结说明

一 .常用的注解 @Api @ApiOperation @ApiImplicitParams @ApiImplicitParam @ApiResponses @ApiResponse @ApiModel @ApiModelProperty 二 .注解整体说明 用于controller类上： 注解 说明 @Api 对请求类的说明 用于方法上面（说明参数的含义）： 注解 ...

wuyundong123的博客 1887

Swagger2.X注解

常用到的注解有： 作用范围 API 使用位置 协议集描述 @Api 用于controller类上 协议描述 @ApiOperation 用在controller的方法上 非对象参数集 @ApiImplicitParams 用在controller的方法上 非对象参数描述 @ApiImplicitParam 用在@ApiImplicitParams的方法里边 对象参数描述 @ApiParam 用在@ApiImplicitParams的方法里边，定义接收的参数形式 描述返回对

Wang8309166的博客 305

swagger注解说明_swagger 常用注解说明

swagger常用注解说明常用到的注解有：ApiApiModelApiModelPropertyApiOperationApiParamApiResponseApiResponsesResponseHeaderapi标记Api 标记可以标记一个Controller类做为swagger 文档资源，使用方式：@Api(value = "/user", description = "Operations...

weixin_39636609的博客 116

Swagger2 注解说明（全）

1、swagger2 注解整体说明 用于controller类上： 注解 说明 @Api 对请求类的说明 用于方法上面（说明参数的含义）： 注解 说明 @ApiOperation 方法的说明 @ApiImplicitParams、@ApiImplicitParam 方法的参数的说明；@ApiImplicitParams 用于指定单个参数的说...

nomejin123的博客 866

swagger注解说明_swagger常用注解说明

常用到的注解有：ApiApiModelApiModelPropertyApiOperationApiParamApiResponseApiResponsesResponseHeader1. api标记Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源，使用方式：@Api(value = "/user", description = "Operation...

weixin_34696080的博客 263

Swagger响应注解：自定义响应信息与状态码

摘要：Swagger的@ApiResponse和@ApiResponses注解可自定义API响应信息，解决默认描述不完整的问题。@ApiResponse定义单个响应（含状态码、消息和返回类型），而@ApiResponses支持多响应场景组合。示例展示了成功响应（200返回用户对象）和错误处理（404/500状态码），显著提升API文档的可读性和维护性。这两个注解是优化Swagger文档的核心工具。

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值