swagger参数与实体中参数不一致原因分析

最新推荐文章于 2024-05-25 22:41:53 发布
最新推荐文章于 2024-05-25 22:41:53 发布
阅读量1.7k 收藏 2
点赞数 3
分类专栏： JAVA 文章标签： java swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fxzzq/article/details/127330101
版权

背景

在项目开发定义接口过程中，我使用swagger生成接口文档时发现入参多了一个参数？当时觉得很奇怪，一定要搞明白，咋回事呢？
以下是复现场景。
在这里插入图片描述
入参实体类定义
在这里插入图片描述
响应实体类定义
在这里插入图片描述
启动项目，奇怪的事情就是输出了以下的api。
在这里插入图片描述

分析总结

定义的入参实体类 和响应实体类的@ApiModel命名重复了。

解决办法

就是让其命名变成不一样即可。
修改其中一个实体。
在这里插入图片描述

成功截图

在这里插入图片描述

勤快的小蚂蚁
关注
  • 3
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
MySQL表生成实体
06-26
总的来说，MySQL表生成实体是一项实用的开发辅助功能，结合Swagger风格，不仅可以提高开发效率，还能确保API文档的清晰性和一致性。对于大型项目而言，这样的自动化工具是必不可少的，能够显著减少手动编码的工作量...
Springmvc整合swagger
05-25
- **实时更新**：Swagger 会随着代码的修改实时更新 API 文档，避免文档与代码不一致的问题。 - **交互式文档**：用户可以通过 Swagger UI 直接测试 API，快速验证接口的正确性。 - **提高开发效率**：开发者可以...
swagger-ui页面接口的入参出参与代码实体类不一致有差异
luckjump的博客
09-26 1860
swagger-ui页面接口的入参出参与代码实体类不一致有差异 后端开发，在进行后端接口开发时，会用到swagger进行接口管理。 路径：http://local:8080/xxx/swagger-ui.html 但是在swagger-ui页面，查看接口时，发现入参出参列表与自己开发的接口出入参实体类不一样。 碰到这个问题，很多人第一反应，以为是 浏览器缓存，客户端缓存等导致的，其实不是的，真正原因是开发人员定义的实体类的api model名导致的。 比如工程中有两个实体类，这两个实体类是完全不一样的，
swagger中参数和实际代码中不一致的问题
qq_30024063的博客
01-28 902
swagger中参数和实际代码中不一致的问题
JavaWeb常用注解
最新发布
CH_happy的博客
05-25 855
如果要注入的属性非常的多，并且还想做到复用，就可以定义这么一个bean对象。在其他的类当中，我要想获取到注入进来的属性，我直接注入 bin 对象，然后调用 get 方法，就可以获取到对应的属性值了。所以这项依赖它的作用就是会自动的识别被。答案是肯定有，在Spring中给我们提供了一种简化方式，可以直接将配置文件中配置项的值自动的注入到对象的属性中。一般将我们定义的controller，service，dao这些包呢，都放在引导类所在包com.xxx的子包下，这样我们定义的bean就会被自动的扫描到。
关于踩坑：swagger中参数和实际代码中不一致的问题
sinat_15934687的博客
04-09 4025
突然前端说：接口不好使，我试了试发现好用呀，前端扔过来一张图片：传的参数和我定义的完全不一样，撕逼一通发现是swagger的问题 swagger中的参数和实际代码中不一样，经过咨询度娘发现定义@ApiModel的时候，有两个类的value值相同，这样的情况下swagger认为这个同一个东西，会优先取第一个（盗一个图，原作者看到的备注下原博文的链接哈） 写代码还是要多多注意噻~ ...
Swagger中参数与实体类中参数不一样的原因
jiandan7410的博客
08-12 929
@ApiModel("实体类名称") 可能原因是定义实体类的时候@ApiModel在多个类上有重复命名的。
swagger上的model和返回的数据字段不一致的问题
qq_45932382的博客
05-30 765
今天在项目中遇到一个问题，swagger中的model和接口返回的字段对应不上，比较郁闷，检查了一下，发现是在使用swagger注解@ApiModel（）时，出现2个内容一致的文字。
swagger文档请求参数和后端入参请求对象不一致问题
qq_52531012的博客
03-28 363
后端对象属性设置前端传递的参数不一致。
springBoot+swagger+Hibernate+Redis+Mysql Demo
02-05
在SpringBoot项目中，通过Swagger UI，开发者可以生成交互式的API文档，直观地展示接口定义、参数、返回结果等，方便API的测试和调试。 3. Hibernate： Hibernate是一个Java ORM（对象关系映射）框架，它允许...
swagger文档编写
01-31
5. 使用Swagger UI进行测试，确保API的实际行为与文档描述一致。 通过以上方式，Swagger可以帮助我们创建高质量、易于理解和使用的API文档，加强前后端开发人员之间的沟通，提高开发效率，降低维护成本。在API编写...
mybatis 代码自动生成 ，并且自定义注释结合swagger
10-15
在MyBatis项目中，我们可以在Mapper接口和实体类中添加Swagger的注解，如`@Api`、`@ApiOperation`、`@ApiParam`等，来描述API的功能、参数及返回值。这样，当我们优化MBG时，也可以确保生成的代码能够与Swagger注解...
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 参数说明与实际不一样
new Girl的博客
11-02 320
就在类头上加 @ApiModel(value = "获取审核列表") 这个注解
Swagger中展示的请求参数错误问题
weixin_48276298的博客
07-13 2417
基本介绍 问题描述：在Swagger中展示的请求参数不是真正controller中的方法参数，而是工程中另外一个类的。 问题定位：原来是因为多个类使用了Swagger中的@ApiModel注解，并且在该注解中的value属性值一样，导致Swagger加载了另一个类作为请求参数。 解决方法：只需要把不同的类中的@ApiModel中的value属性值设置成不一样即可。 ...
使用swagger时碰到的坑——次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题
极赫赫的博客
05-23 1231
本文主要是针对使用swagger时碰到的坑（次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题），进行分析与处理，需要的同学可以参考下。
接口响应字段和swagger展示不一致
weixin_45608477的博客
11-13 1116
无意间发现，swagger展示的字段和自己接口中的字段不一样，但是调用后，响应的数据是正常的。 排查。 swagger截图： 接口字段： 原因： 项目中有两个ContentItem，名字一样造成的。
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界面 @RequestBody 参数类错误，变成了其他参数类
你当像鸟飞往你的山~~
03-18 2731
遇到一个问题：swagger界面 @RequestBody 参数类错误，变成了其他参数类，不是相应的类，看类写的没错，属性都没错，检查半天 结果原因是：有两个类的注解值一样的，这种问题一般是复制问题，或多人开发写的问题 两个注解值写的一样，导致一直是前者的属性字段， ...
swagger ApiModelProperty 请求参数有些不显示
04-26
Swagger是一种用于构建、文档化和可视化RESTful API的工具。在Swagger中，使用`@ApiModelProperty`注解来描述API的请求参数。如果你在使用Swagger时发现请求参数不显示，可能有以下几个原因： 1. 注解未正确使用：请确保在请求参数的字段上正确使用了`@ApiModelProperty`注解，并提供了必要的参数描述信息。例如，你可以使用`value`属性来描述参数的名称，使用`example`属性来提供参数的示例值。 2. Swagger配置问题：请检查你的Swagger配置文件，确保已经正确启用了请求参数的显示功能。通常，你需要在Swagger配置文件中设置`enable`属性为`true`，以显示请求参数。 3. 编译问题：如果你在编译代码出现了错误或警告，可能会导致Swagger无法正确解析和显示请求参数。请确保你的代码没有编译错误，并且所有的依赖项都已正确引入。 如果以上方法都无法解决问题，建议你提供更多的详细信息，例如你的代码片段或Swagger配置文件，以便更好地帮助你解决问题。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

勤快的小蚂蚁

奖励下我呗！

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值