关于踩坑：swagger中参数和实际代码中不一致的问题

已于 2023-05-06 10:46:57 修改
阅读量4k 收藏 2
点赞数 4
分类专栏： 踩坑 经验 文章标签： java
于 2021-04-09 10:45:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_15934687/article/details/115541010
版权

突然前端说：接口不好使，我试了试发现好用呀，前端扔过来一张图片：传的参数和我定义的完全不一样，撕逼一通发现是swagger的问题

swagger中的参数和实际代码中不一样，经过咨询度娘发现定义@ApiModel的时候，有两个类的value值相同，这样的情况下swagger认为这个同一个东西，会优先取第一个（盗一个图，原作者看到的备注下原博文的链接哈）

写代码还是要多多注意噻~

啊啊啊啊啊啊啊，又发现一种情况会导致swagger中返回值没有实体结构：

   本地项目使用JRebel启动的时候

所以本地看swagger还得用run或者debug,不能使用JRebel run 或者JRebel debug.

ah Zoey
关注
  • 4
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
专栏目录
Swagger2离线文档：swagger2markup代码和插件方式
01-21
swagger2markup代码方式 第一步：编辑pom.xml增加需要使用的相关依赖和仓库 第二步：编写一个单元测试用例来生成执行生成文档的代码 生成AsciiDoc 生成markdown 生成confluence swagger2markup插件方式 生成asciidoc...
swagger-clientgen:从 swagger api 文档中生成客户端代码
07-05
从 swagger api 文档中生成客户端代码 ##Usage 将一个名为swagger-clientgen的部分添加到grunt.initConfig({}); 称呼。 grunt . initConfig ( { swagger_clientgen : { my - client : { options : { language ...
swagger-ui页面接口的入参出参与代码实体类不一致有差异、swagger请求实体与预期定义不符、swagger参数与实体中参数不一致原因分析
最新发布
weixin_49114503的博客
05-29 270
swagger-ui页面接口的入参出参与代码实体类不一致有差异、swagger请求实体与预期定义不符、swagger参数与实体中参数不一致原因分析
关于使用swagger 中接口显示入参和代码中配置的不一致（错误）import io.swagger.annotations.ApiModel；使用错误
第二颗大白菜
07-07 9587
定义接口的时候，发现进入swagger ui显示接口的入参参数和我代码中的不一致？ 并且两个接口的入参显示一样，但是实际上我代码中引用的是两个入参对象的。不一样的参数。 起初以为是浏览器缓存、服务器缓存，都clean了，还是一样。怎么回事？ 先把代码贴出来。看看 很明显，是两个不一样的接口，两个入参对象，下图为两个入参对象的数据结构。 很明显，两个不一样的对象，但是为什么引用了同一个入参对象呢？？？？？ 仔细一端详，哦。。。。。。@ApiModel配置了同一个名字，也就是说，按照顺序来说，两个.
swagger 生成的接口文档VO字段总是不对？
qq_26661735的博客
04-23 146
但是，我的经验和它们不同。我有一个VO的字段是一个列表，列表元素的类型是一个嵌套类（假设叫A）！然后这个类名和系统中另一个嵌套类B的类名相同！然后不知道为什么，生成的文档中，本该是展示A的字段的地方，居然展示B的字段！我死磕了1个多小时，才发现这个巨坑！把A的类名改一改，和B不同就解决了！TMD，希望这个经验能帮到你。我也不说版本的事情了，直接说。
swagger 内容信息与代码不一致，已解决
努力努力，努力努力的博客
02-21 421
ApiModel是Swagger中的常用到的注解，检查下信息错误的实体类的@ApiModel的value值是否一致，应该是写错了，是不是张冠李戴了。
swagger中参数和实际代码中不一致的问题
qq_30024063的博客
01-28 902
swagger中参数和实际代码中不一致的问题
Swagger踩坑：入参和显示不一致问题
GodSure0914的博客
08-03 1339
这个问题还是比较坑的，idea和浏览器缓存都快被我清烂了都解决不了，最后从大佬那找到了解决办法。 出现问题的原因：偷懒直接复制类导致@apimodel里面的类名没有改，不怎么聪明的swagger加载了别的类~ 解决办法：修改@apimodel里面的参数 ...
swagger-ui页面接口的入参出参与代码实体类不一致有差异
luckjump的博客
09-26 1860
swagger-ui页面接口的入参出参与代码实体类不一致有差异 后端开发，在进行后端接口开发时，会用到swagger进行接口管理。 路径：http://local:8080/xxx/swagger-ui.html 但是在swagger-ui页面，查看接口时，发现入参出参列表与自己开发的接口出入参实体类不一样。 碰到这个问题，很多人第一反应，以为是 浏览器缓存，客户端缓存等导致的，其实不是的，真正原因是开发人员定义的实体类的api model名导致的。 比如工程中有两个实体类，这两个实体类是完全不一样的，
swagger调用接口显示的数据和真实返回的数据有差异
黄坤的博客
04-09 1766
今天遇到一个奇怪的问题，就是接口返回的数据和swagger调用接口后展示的数据有区别 数据库中的数据 可以看出当我phone为hk12345时对应的user_id为1380508531521015809 接口返回的数据 可以看出我接口返回的user_id也是1380508531521015809 swagger显示的数据 可以看到swagger显示的userId和之前的不同，但是又很相似 后面发现id太长，数据失真了，只要在实体类的属性上加上@JsonFormat(shape= Json
swagger参数与实体中参数不一致原因分析
勤快的小蚂蚁的博客
10-15 1702
在项目开发定义接口过程中，我使用swagger生成接口文档时发现入参多了一个参数。
swagger-annotations-2.1.2-API文档-中文版.zip
05-09
赠送jar包：swagger-annotations-2.1.2.jar； 赠送原API文档：swagger-annotations-2.1.2-javadoc.jar； 赠送源代码：swagger-...人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
swagger-annotations-1.5.24-API文档-中文版.zip
05-09
赠送jar包：swagger-annotations-1.5.24.jar； 赠送原API文档：swagger-annotations-1.5.24-javadoc.jar； 赠送源代码：swagger-...人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
swagger-parser：Swagger 2.0和OpenAPI 3.0 parservalidator
02-04
Swagger 2.0和OpenAPI 3.0解析器/验证器产品特点解析JSON或YAML格式的Swagger规范针对或所有$ref指针，包括外部文件和URL 可以将所有Swagger文件到一个只有内部$ref指针的文件中可以所有$ref指针的，从而为您提供...
swagger文档请求参数和后端入参请求对象不一致问题
qq_52531012的博客
03-28 363
后端对象属性设置前端传递的参数不一致。
swagger上的model和返回的数据字段不一致的问题
qq_45932382的博客
05-30 765
今天在项目中遇到一个问题，swagger中的model和接口返回的字段对应不上，比较郁闷，检查了一下，发现是在使用swagger注解@ApiModel（）时，出现2个内容一致的文字。
swagger文档请求参数和后端入参请求完全对象不一致
m0_62472302的博客
01-04 410
但是swagger文档 b接口显示入参居然是a ,尝试过清除缓存,maven清空重新编译仍然还是这个问题,居然因为我在b接口入参。LineRpDto这个对象里的@ApiModel写的文字和a接口一样,识别错误。总结 @ApiModel里面的值 不能一样。发生一个灵异时间,b接口请求的。
swagger中Model字段与传入参数不一致问题
Crzep的博客
03-04 1247
下面是我写的javaBean @Data @ApiModel(value = "图片传入数据实体",description = "图片传入数据实体") public class TSourInfo { @NotNull(message = "铭牌id不能为空！") @ApiModelProperty(value = "铭牌id",required = true) private Long nameplateId; @ApiModelProperty(value = "图片名
swagger 类属性显示不正确字段属性显示不正确
weixin_43465497的博客
02-25 4261
问题描述： 使用swagger过程中，针对接口返回值包含的结构体Class A使用注解说明后，发现接口描述信息中返回值对应并不是对应的实体类Class A,而是变为了类Class B，当然class B对应的类属性也不会是class A的属性。 问题剖析 @ApiModel("这是class A的描述") public class A { @ApiModelProperty("id") pri...
swagger中 @ApiModelProperty的作用和参数说明
01-31
@ApiModelProperty是Swagger框架中的一个注解，用于对模型类的属性进行说明或者数据操作更改。它可以用来描述属性的含义、数据类型、是否必填等信息。 @ApiModelProperty的参数说明如下： - value：属性的简要描述。 - name：属性的名称。 - dataType：属性的数据类型。 - required：属性是否为必填项。 - example：属性的示例值。 - hidden：属性是否在Swagger文档中隐藏。 下面是一个示例： ```java @ApiModel(value = "User", description = "用户信息") public class User { @ApiModelProperty(value = "用户ID", example = "1") private Long id; @ApiModelProperty(value = "用户名", required = true) private String username; @ApiModelProperty(value = "年龄", dataType = "int") private int age; // 省略其他属性和方法 } ``` 在上面的示例中，@ApiModelProperty注解被用于描述User类的属性。例如，id属性被描述为用户ID，age属性被描述为年龄。同时，还可以指定属性的数据类型、是否必填以及示例值等信息。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值