Swagger注解-@ApiResponses 和 @ApiResponse

原创 最新推荐文章于 2026-03-22 00:59:10 发布 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

台积电技术研发实力

台积电技术研发实力 台积电在半导体行业的地位毋庸置疑。他们究竟有多强大，大部分读者了解得可能非常片面。从最新公布的2019年财报里，看看台积电的真正实力。 一、台积电在市场上的地位 根据公司财报，台积公司在先进制程技术、特殊制程技术，以及先进封装技术的发展上持续领先全球集成电路制造服务领域，2019年的市场占有率为52%。台积公司总体营收以地区划分（主要依据客户营运总部所在地），来自北美市场的营收占台积公司总体营收的60%、日本与中国大陆以外的亚太市场占9%、中国大陆市场占20%、欧洲、中东及非洲市场占6

吴建明wujianming_110117 1901

SEG-Y 数据介绍及读写

无

1万+

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

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

qq_25983579的博客 5万+

kaggle——销量预测的baseline（M5 Forecasting - Accuracy）

前言 在刚刚结束的kaggle比赛M5 Forecasting - Accuracy中，因为是第一次参加，笔者也是花了大量的时间和精力在上面，最终拿到一块银牌（所以我拿到了大学第一个考试挂科。。。求求电磁场老师高抬贵手给点平时分放我一马吧。。。早上看到kaggle成绩异常兴奋，中午考完直接爆炸=。=），当然运气占了很大因素，这次比赛private leadboard的shake up非常大，排名波动几千名都存在的。笔者运气不错，是向上的shake：)。这里总结一下销量预测的基本流程。 从下图可以看到这次比

weixin_43901221的博客 5432

swagger注解类说明

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

顾丽江的专栏 4114

AXI4接口说明

ACLK：全局AXI接口时钟输入（建议与系统时钟保持一致）ARESET_n：全局AXI接口复位信号，低电平有效。PS：在HBM AXI接口应用中，此复位端口仅应在数据传输开始前使用。若在传输开始后使用，会导致AXI接口与内存控制器失步（out-of-sync）。当开关启用时，IP核会将所有ARESET_n引脚内部连接在一起——因为内存作为一个整体工作。

rhtul的博客 1522

uni-app蓝牙MTU设置失效探因：从20字节限制到跨设备兼容性实战

本文深入探讨了uni-app蓝牙开发中MTU设置失效的常见问题，特别是20字节限制的成因及解决方案。通过分析设备兼容性、蓝牙协议栈特性和系统版本差异，提供了智能延迟策略、设备特征检测和渐进式MTU提升等实战方案，帮助开发者优化蓝牙数据传输效率。

weixin_29289821的博客 288

Swagger基本配置及常用注解

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

qq_36917119的博客 2644

[VT虚拟化驱动]正式启动VT

文章目录前言一、vmlaunch正式开始虚拟化二、使用步骤1.引入库2.读入数据总结 前言 本章开始真正实现一个最简单的VT框架，当然，只是能跑起来一个VT驱动了，没有并包括EPT，EPT后面再讲 提示：以下是本篇文章正文内容，下面案例可供参考 一、vmlaunch正式开始虚拟化 执行VMLAUNCH指令执行后，就正式进入虚拟化了，再该指令执行之前，得先保存Guest当前的环境，执行完VMLAUNCH后，要恢复Guest的环境，让Guest就像什么都没发生一样，所以需要保存和恢复Guest的各种寄存器的值

吾无法无天的博客 3661

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

【虚幻引擎UE】UE5 仅需6步轻松实现关卡顺滑切换

【虚幻引擎UE】UE5 仅需6步轻松实现关卡切换

灵境引路人 2万+

1、JMP脚本编程全面指南：从基础到高级应用

本博客全面介绍了JMP脚本编程的各个方面，从JMP基础和JSL入门，到数据类型、数据结构、编程方法、数据表操作、图形与三维场景脚本，再到应用程序创建与扩展功能。内容涵盖脚本工具使用、常见任务实现、兼容性说明及未来发展趋势，旨在帮助用户掌握JMP脚本语言的强大功能，提升数据分析的自动化与定制化能力。适合从初学者到高级用户的深入学习与实践参考。

flink9streamer的博客 266

swagger 常用注解

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

aocheqing0591的博客 786

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

Swagger 常用注解使用详解

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

sunspun的博客 458

SAP B1中文培訓教材_SDK

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

IDEA的使用指南

IDEA基于java的使用手册,可以最快速的上手,在使用中不断的丰富自己的使用技巧.

swagger常用注解

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

u013291972的博客 1万+

Statistics and Machine Learning Toolbox

Statistics and Machine Learning Toolbox（带书签），MATLAB统计学习工具

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

余额充值