Swagger注解@ApiModel-value值相同时，文档字段定义新增或者修改时无效（很容易误以为是缓存问题，各种重启清缓存也无效）

已于 2023-06-13 16:20:18 修改
阅读量553 收藏 2
点赞数 1
文章标签： java 开发语言
于 2023-06-13 16:17:54 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36951116/article/details/131190764
版权

解决方法在最后，时间急的直接看最后把

描述：因为这个问题导致以为是缓存问题，各种重启服务、清浏览器缓存都还是一样，新增字段就是不在文档中显示。

解决过程：

看swagger源码，debug追踪。

最终定位代码问题在：

springfox.documentation.swagger2.mappers.ModelSpecificationMapper#modelsFromApiListings

 多个controller方法，如果有参数或者相应的bean的@ApiModel的value相同，putAll会根据这个@ApiModel的value作为key，最终modelMap相同的key会相互覆盖，只保留其中一个文档定义。

解决方法：@ApiModel的value值改为不一样，然后重启服务即可

后面百度了下，也有人发现这个问题了：Swagger注解@ApiModel的巨坑_不忘初心mm的博客-CSDN博客

东纪元
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
swagger-models-2.1.2-API文档-中文版.zip
05-09
赠送jar包：swagger-models-2.1.2.jar； 赠送原API文档：swagger-models-2.1.2-javadoc.jar； 赠送源代码：swagger-models-2.1.2-sources.jar； 赠送Maven依赖信息文件：swagger-models-2.1.2.pom； 包含翻译后的API文档：swagger-models-2.1.2-javadoc-API文档-中文(简体)版.zip； Maven坐标：io.swagger.core.v3:swagger-models:2.1.2； 标签：core、models、v3、swagger、jar包、java、中文文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
swagger注解@ApiModel value 不能同名
abde630154071的博客
08-31 1249
@ApiModel(value=“AbnormalScanReqDto”, description=“异常扫描”) 如果出现崇明, swagger文档就会出现乱串, 参数不对.
在线问题反馈模块实战(五):实现对通用字段内容自动填充功能
**My Coding Family**
07-17 444
在线问题反馈模块实战教学，等你来白嫖，非常详细，适合新手小白学习。
通过反射获取属性名称，以及属性值，以及获取@ApiModelProperty参数的value
weixin_44859876的博客
12-21 1321
通过反射获取属性值和属性名称，
一个我一直以为是Swagger缓存的巨坑，今天终于解决了
gaoshan12345678910的博客
11-01 1888
最近项目开始使用Swagger作为Api文档的编写工具，Swagger确实是为开发工作带来了很多方便。但是偶尔总会出现明明接口说明已经修改了，但在doc.html上总是看到旧的字段描述。甚至有时字段已经删除了，不管怎么重启，怎么清缓存，还是赖着在那里。 期间一直以为是缓存的问题，各种请浏览器缓存，换浏览器，甚至删除操作系统的tmp目录，都是无法解决。导致这期间总是被前端开发人员说我的接口与文档描述不符。心累啊。 今天无意间打开了“Swagger Models”菜单，发现界面上显示的model数量怎么那么
@ApiModel 遇到的问题
Qbaiwan的博客
11-03 1697
使用 swagger2 中的 @ApiModel 注解不规范遇到的 swagger 文档 错乱问题: 1. 习惯 以前使用swagger2时, 在出入参实体上添加注解@ApiModel时习惯性的添加value = "XXX"属性, 旧版本中一直没有发现有什么问题. 2. 遇坑 最近在使用swagger2:2.9.2版本时, 遇到一个问题,swagger文档中的 入参 结构示例中的入参参数跟代码的入参对象中的字段不匹配不一致, 导致接口联调问题多 3. 排查 经过排查发现是因...
SpringBoot入门笔记02-mybatis&swagger2&热部署&单元测试&EHCACHE缓存&全局异常&数据校验
YiGeFive的博客
04-19 331
UserDao 接口添加数据访问基本方法。
问题梗概:swagger有缓存，swagger查找不到代码变动，配置swagger出错。
MovemOemVeovE的博客
07-14 2644
问题梗概:swagger有缓存，swagger查找不到代码变动，配置swagger出错。 1.遇到的问题：刷新swagger.html，不显示代码的任何改动（比如新增了接口，之前返回很多数，现在直接改成返回1），就像是有缓存一样，swagger展示的是另一个程序的体现。 原因：由于公司和现场环境不一样，有些代码是冲突的，所以在一个文件夹里没法同时写，所以就clone了多份代码下来，结果就导致了这个问题。问题发生在工程下的.idea文件夹下的modules.xml， <?xml version="1.0
springboot swagger 同一个model 根据group 在不的api中展示不同的字段和描述
g5zhu5896的博客
11-24 4393
主要是为了让一个实体可以用于不同的接口展示不同的字段,减少dto的数量,但是不宜过度使用,不然代码就被注解占满了 @ApiGroupProperty(value={GroupsUser.Update.class},description="")用于给Model字段分组,value控制所属组,description可以设置不同的字段描述 @ApiGroupProperties(value = {@ApiGroupProperty({)}}）可以包含多个@ApiGroupProperty以便给不同分组的Mo
swagger-annotations-1.6.2-API文档-中文版.zip
06-04
赠送jar包：swagger-annotations-1.6.2.jar； 赠送原API文档：swagger-annotations-1.6.2-javadoc.jar； 赠送源代码：swagger-annotations-1.6.2-sources.jar； 赠送Maven依赖信息文件：swagger-annotations-1.6.2....
swagger-bootstrap-ui-1.9.6-API文档-中文版.zip
07-13
赠送jar包：swagger-bootstrap-ui-1.9.6.jar； 赠送原API文档：swagger-bootstrap-ui-1.9.6-javadoc.jar； 赠送源代码：swagger-bootstrap-ui-1.9.6-sources.jar； 赠送Maven依赖信息文件：swagger-bootstrap-ui-...
springfox-swagger-common-3.0.0-API文档-中文版.zip
05-09
赠送jar包：springfox-swagger-common-3.0.0.jar； 赠送原API文档：springfox-swagger-common-3.0.0-javadoc.jar； 赠送源代码：springfox-swagger-common-3.0.0-sources.jar； 赠送Maven依赖信息文件：springfox-...
java方法重写（重点讲），方法重载
weixin_46281068的博客
04-27 875
一、方法重载定义：一个类中，出现多个方法的名称相同，但是它们的形参列表是不同的，那么这些方法就称为方法重载了。注意：一个类中，只要一些方法的名称相同、形参列表不同，那么它们就是方法重载了，其它的都不管（如:修饰符，返回值类型是否一样都无所谓）。形参列表不同指的是:形参的个数、类型、顺序不同，不关心形参的名称。应用场景：开发中我们经常需要为处理一类业务，提供多种解决方案，此时用方法重载来设计是很专业的。
Day25-Java基础之常用类1
m0_46053885的博客
04-27 858
同时我们发现Math类中的方法都是静态的，因此在使用的时候我们可以直接通过类名去调用。对于计算机而言，其实是没有数据类型的概念的，都是0101010101，数据类型是编程语言自己规定的，所以在实际存储的时候，先把具体的数字变成二进制，每32个bit为一组，存储在数组中。比较内存地址值一般情况下是没有意义的，我们希望比较的是对象的属性，如果两个对象的属性相同，我们认为就是同一个对象；如果我们的数据是一个浮点类型的数据，有的时候计算机并不会将这个数据完全转换成一个二进制数据，而是将这个将其转换成一个无限的。
链表刷题集
最新发布
yajunjiao的专栏
04-30 263
本文主要列举了一些刷的题，不多，有那么几道，也建议各位去建立自己的刷题集。积少成多。
MSE实现全链路灰度实践
云计算、数据库、大数据、深度学习、NLP、Python
04-24 360
待更新。
Java | 冒泡排序算法实现
yingzix688的博客
04-24 834
题目描述 编写一个Java程序，实现冒泡排序算法。程序需要能够接收一个整型数组作为输入，并输出排序后的数组。 冒泡排序是一种简单的排序算法，它重复地走访过要排序的数列，一次比较两个元素，如果他们的顺序错误就把他们交换过来。走访数列的工作是重复地进行直到没有再需要交换，也就是说该数列已经排序完成。
【限流】基于springboot（拦截器） + redis（执行lua脚本）实现注解限流
qq_43209531的博客
04-30 53
基于springboot（拦截器） + redis（执行lua脚本）实现注解限流
@ApiModel(value="Student对象", description="") 注解的作用
05-19
@ApiModel 注解用于对一个类进行描述，用于生成 API 文档。它可以描述一个类的基本信息，如名称、描述、属性等。在 Swagger 中，@ApiModel 注解通常与 @ApiModelProperty 注解一起使用，用于生成 API 接口文档。 具体来说，@ApiModel 注解中有两个属性值： - value：表示该类在 API 文档中的名称。 - description：表示该类在 API 文档中的描述信息。 例如，对于一个名为 Student 的类，我们可以使用 @ApiModel 注解来对其进行描述： ``` @ApiModel(value="Student对象", description="学生对象信息") public class Student { ... } ``` 这样，在生成的 API 文档中，就会显示出该类的名称和描述信息。同时，如果我们在该类的属性上使用 @ApiModelProperty 注解，也可以在文档中显示出每个属性的名称、描述、数据类型等信息。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值