swagger返回数据说明字段注释说明（已解决）

最新推荐文章于 2024-12-28 19:40:25 发布
原创 最新推荐文章于 2024-12-28 19:40:25 发布 · 2.4w 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java  #swagger # 注释说明

本文解决了一个关于Swagger接口文档中注释缺失的问题，指出在未给返回值ResponseEntity定义泛型时，会导致注释无法显示。文章强调了实体类配置@ApiModelProperty()的重要性，并分享了解决方案。

在这里插入图片描述
本人开发时跟前端对接，swagger没有右侧的注释被吐槽了，查了半天发现是没有给返回值ResponseEntity定义泛型

在这里插入图片描述
没有泛型就没有注释说明
不过前提是实体类配置
@ApiModelProperty()
如果能帮到你，就给点个赞吧。谢谢！！

sgycoder
关注
Swagger配置Model但接口无描述信息且Java响应参数名称不同
TechWhizZ的博客
08-14 652
对于缺失描述信息的情况，我们需要检查是否正确配置了Swagger的Docket对象。在Swagger中，我们可以通过注解来对接口进行描述，包括接口的作用、参数说明、返回值说明等。但有时候，即使我们在代码中正确添加了这些注解，Swagger页面上的接口描述却没有显示出来。有时候，我们在Java代码中定义了一些Model类，但在Swagger页面上，响应参数的名称与我们预期的不同。完成以上步骤后，重新启动应用程序，打开Swagger页面，你将看到响应参数的名称已经按照我们的预期进行了修改。作为响应参数的名称。
swagger返回map字段注释
小白菜
05-04 1万+
1.效果图如下： 2.controller层代码： import java.util.HashMap; import java.util.Map; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; impor...
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
Swagger给返回参数添加注释说明
热门推荐
qq_25983579的博客
02-27 5万+
处理效果 第一步,控制层加上注解 @ApiResponses({ @ApiResponse(code = 200,message = "OK",response = TrainUserTEntity.class), }) 第二步,实体类属性上面加上注解 @ApiModelProperty(value = "姓名", required = true) ...
swagger 返回参数注解
小石头
12-17 9299
第一种 @ApiOperation(value = "取消/流失列表") @GetMapping("/getStudentLoseList") @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "type", value = "类型（0:取消分班 1:流失）",required = true,dataType = "int"), @ApiImplicitParam(paramType = "query".
SpringBoot配置Swagger接口文档参数及返回值注释详细操作
weixin_44906271的博客
04-27 3万+
目录SpringBoot中配置SwaggerSwagger常用注解测试注解用途用实体类接收参数或者返回数据配置 SpringBoot中配置Swagger 1. 导入依赖 官方推荐里说只需要前面两个依赖就可以了，但实测只导入上面两个依赖的话，后台会报依赖，网上查询加上下面两个依赖后不报异常了，原因未知。 <dependency> <groupId>io.spring...
Swagger2及常用校验注释说明
王广帅--游戏开发-服务器开发
06-27 550
【代码】Swagger2及常用校验注释说明。
swagger.v3 类字段注释的注解
10-15
2. **@ApiModelProperty**: 这个注解用于详细说明单个字段，如字段名称、描述、数据类型、必填等。例如： ```java private int id @ApiModelProperty(name = "id", description = "用户的唯一标识", required = ...
彻底解决若依ruoyi项目swagger/knife4j没有响应字段说明
最新发布
C3245073527的博客
12-28 2746
填若依swagger/knife4j返回值没有注释说明的坑
java-1.swagger注解的使用
LGD
09-02 1473
@Api：用在请求的类上，表示对类的说明 tags=“说明该类的作用，可以在UI界面上看到的注解” value=“该参数没什么意义，在UI界面上也看到，所以不需要配置” 4@ApiOperation：用在请求的方法上，说明方法的用途、作用 value=“说明方法的用途、作用” notes=“方法的备注说明” @ApiImplicitParams：用在请求的方法上，表示一组参数说明 @ApiImpl...
swagger返回参数的注释
爱生活爱敏敏的博客
01-20 1万+
.net core3.0 webapi 首先安装包Swashbuckle.AspNetCore.Annotations 然后在Startup配置swagger地方加上一句代码 i.EnableAnnotations();//注释 使用的话在控制器的方法中加上 [SwaggerResponse(0,"文档注释",typeof(Product))] 注意这个typeof的参数就是你要返回的...
关于Swagger的@ApiModel 返回内容注释不显示问题解决方案
玩转Java
04-27 9120
使用统一的返回封装类。
swagger返回多数据列表,中文注释
shaokunkun的博客
04-24 6700
因为业务需要,一个查询接口,需要给前端返回二个列表对象数据,用map返回,发现swagger没有各个字段的中文注释,最简单方式还是封装一个组合实体类,将需要返回前端的数据都封装在里面即可!最后将该实体类再controller层定义好实际返回泛型即可! 自定义的组合类,记得定义泛型哦!不然中文注释无法显示 控制层这里要定义好返回值泛型 最后swagger的返回参数字段中文注释就完美...
关于Swagger@ApiModel返回内容注释不显示问题
qq_25635131的博客
10-23 4335
处理swagger返回值的时候返回VO不显示备注，乘了一波凉，先贴出别人栽的树：原文链接https://blog.youkuaiyun.com/qq_32917699/article/details/81486060 今天做了一天@ApiModel希望Swagger生成的文档出现返回的内容注释，发现需要用到@ApiModel注解到你需要返回的类上 @ApiModelProperty作为字段的描述 例如 之后文...
.Net Core WebApi 程序在Swagger API说明文档中不显示注释的解决办法
编程技术探索者，分享C/C++、C#、Java、数据库等开发经验，聚焦实战技巧与AI兴趣，助力编程爱好者成长。
06-18 1303
.Net Core WebApi 程序在Swagger API说明文档中不显示注释的解决办法
Swagger2接口API返回JSON、Map等对象的备注说明
willem的博客
03-05 7018
描述 目前使用Swagger2形成接口文档时，当系统设计的接口返回的类型不是实体对象时，Swagger2无法在接口文档页面中显示返回结果字段说明，比如返回json、map等可以存储key-val形式的类型；均无法在接口文档页面上显示返回的字段备注说明，所以怎么才能像实体对象一样显示正常的model字段说明是我们这次需要解决的问题； 首先告诉Swagger2该接口需要返回的字段具体有哪些 定义两个...
Swagger接口返回JSON,Map的字段注释比较优雅的实现
austindev的博客
08-05 4253
看很多小伙伴写的接口，既想要Map的灵活扩展性，又苦于生成的接口文档没办法把已知的字段解释清楚；导致接口文档效果打折扣，还得另行约定文档，或者直接嘴上沟通了事；目前使用Swagger2形成接口文档时，当系统设计的接口返回的类型不是实体对象时，Swagger2无法在接口文档页面中显示返回结果字段说明，比如返回json、map等可以存储key-val形式的类型；均无法在接口文档页面上显示返回的字段备注说明；所以怎么才能像实体对象一样显示正常的model字段说明是我们这次需要解决的问题；...
swagger 返回值描述
zhaofuqiangmycomm的博客
03-17 6305
今天被前端训了一顿,慌得一逼,说你们写的接口,返回值写的是什么东西,只有公共的三个字段...... 我们的API文档是基于 swagger组件写的.如是有了下面的东东 示例: 1.1.返回字段 1.1.1.返回字段(对象) 1.将现有接口@ApiOperation注解,response字段去掉. 该字段作用:声明指定返回值对象 修改后: 2.将返回对象进行泛型声明 声明后swagger(丝袜哥) 会...
评论 6
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值