swagger解决接收参数为实体时，不加@RequestBody页面不显示参数注解方案

最新推荐文章于 2024-07-24 14:26:49 发布
最新推荐文章于 2024-07-24 14:26:49 发布
阅读量5w 收藏 19
点赞数 5
分类专栏： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/aa292016616/article/details/86013037
版权

1.场景：因为在项目里做了接口签名,所以用的请求格式都是form。因为规范接口的请求参数都是用实体类接收，但是form表单提交不支持@RequestBody 所以swagger显示不了注解说明。如果在接口上加@ApiParam参数一多显的代码太臃肿

2.解决方法

   在接收实体参数前加@ModelAttribute即可，不用这个是干什么用的可以去查一下

效果

aa292016616
关注
专栏目录
Spring Boot进阶(29)：如何正确使用Spring Boot注解@PathVariable、@RequestParam和@RequestBody: Postman演示教程
**My Coding Family**
10-18 5162
如何正确使用@PathVariable，@RequestParam、@RequestBody等注解？不会我教你，结合Postman演示|超级详细，建议收藏
【swagger】swagger 怎么注解 对象类型的参数
九师兄
06-03 363
如果请求参数为某个对象，还需要在swagger里显示出注释第一步：在对象的类上加注解@ApiModel，类的字段上加注解第二步：controller类里直接使用，json接收（如果是想表单提交，则用第三步（可选）：如果不想展示某些字段在swagger上，需要在字段上加上注解。
Swagger 接口入参使用 @RequestBody 后 @ApiModel标记的对象描述无效
顶顶顶顶顶顶顶顶顶顶顶顶
09-07 4219
Swagger 接口入参使用 @RequestBody 后 @ApiModel标记的对象描述无效 必须去除@RequestBody 后才在Swagger ui 中看到。 因为规范接口的请求参数都是用实体类接收，form表单提交不支持@RequestBody，所以swagger显示不了注解说明。 ...
Swagger对无@RequestBody描述的参数也显示Model
qq_41963466的博客
01-26 4025
Swagger优化 当没有@RequestBody描述参数的时候如何让Swagger显示Model 开始时以为在SwaggerConfig中配置即可，后来发现Swagger没有对应的可配置项。 开始在网上搜索解决方案，最终搜索到： https://blog.csdn.net/Driver_tu/article/details/100031407 但上面的解决方案是用另一个注解去描述对应的参数，我就在想可不可以不用任何注解，有无@RequestBody，Swagger的都是按Model默认展示的 我找到了关于
Swagger Spring Doc：Get请求RequestBody为自定义参数时，没有参数设置框，且后端无法接收
最新发布
山顶听风的博客
07-24 325
针对界面的多条件复杂查询，由于查询条件不定，不好一个条件定义一个参数。创建一个查询类来接收参数。在查询为Get模式时，SpringDoc 的接口调试参数输入界面异常，且后端无法接收查询参数。
正常配置java实体 swagger 返回参数不显示
向着太阳微笑
10-14 9990
2020年10月14日15:53:46 一个神坑问题！ 正常配置swagger注解结果不显示返回参数； 实体： controller: 结果返回参数么有显示！！！！！ 经过多次尝试，对比最后发现问题所在，单没搞明白为啥！ 这里我的注解@ApiModel("淘金广场App端接收对象V1.10") ; 问题就在这个V1.10上，是不是swagger不允许出现1.10的小数点；去掉后就正常了！ 结果正常出现，只是把“.10”删除了！！！！ ...
SwaggerBootstrapUi注释不显示
qq_44094980的博客
01-27 1898
SwaggerBootstrapUi使用大坑-不显示注释 今天写一个接口的时候发现一个奇葩的问题，就是swagger不显示注释的问题，网上百度了很多也没有解决，发现一个SwaggerBootstrapUi的小bug. 先看下我的返回数据封装，有做强泛型指定： controller层 @GetMapping("info/{skuId}") @ApiOperation(value = "获取商品详情", notes = "获取商品详情") @EncryptResponse public
swagger注解（@ApiModelProperty）实体类swagger-ui不显示问题
zhangwenchao0814的博客
05-13 7531
实体类首字母必须小写，否则swagger-ui界面显示对象的参数说明不显示、是否必输属性即使指定必输也是显示false；比如数据库中字段为B_WORKDAYFLAG，使用mybatis-plus代码生成器工具生成后是bWorkDayFlag，此时可以在mybatis-plus代码生成器中设置生成实体类时去掉字段前缀，如： strategy.setFieldPrefix("B_", "C_", "D_", "VC_"); //生成实体时去掉字段前缀 *** 代码*** public static void
@RequestBody注解忘加导致空指针
Lin_SkySea的博客
08-17 522
直接controller开始拿req的参数都是null。请求都是带了参数的。路径也没有问题。 必传参数都有，同时检查了数据库字段和实体以及RequestBody参数是对应的，没有名字错误或者没传或者数据库设置了不为null，以上检查都没问题。就是单纯少了这个注解导致空指针。而且 是开始就为null。第一行代码都没走，（出去方法那一行），而就错在那一行注解@RequestBody没写。 ...
@RequestBody接收前端传来的参数转换为指定的枚举值，mybatis查询出来到的字段值转换为枚举
weixin_42746546的博客
05-11 1313
一、接收前端参数转换为枚举 1.新建枚举 //新建枚举基类，让所有枚举都实现改接口，该接口指定接收参数的自定义反序列处理方式，所有实现该接口的枚举在反序列化的时候都会用自定义的反序列方法，例如controller中@RequestBody接收参数的实体类中枚举属性设置值的时候。 import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import java.io.Serializable; @JsonDeserialize(usin
api响应泛型参数 swagger_swagger2的常用注解，传递参数的注意使用方法
weixin_39729840的博客
12-19 3593
背景介绍：刚开始的时候，在controller层使用@RequestParam的时候，发现这个参数是必须要输入值的，但是我们有时候必须查询的时候允许参数为空，使用这个注解就不行了。在集成了swagger2后，找了半天的原因，发现使用@ApiImplicitParam这个注解可以解决这个问题。对应下面的参数。所以我们可以使用这个注解来解决我们所遇到的参考为空的问题。而且已经集成了swagger2，所...
java接收参数_javaWeb收传参数方式总结
weixin_31232695的博客
02-12 1171
1.GET和POST请求,在传参方面有什么区别GET传输的数据存储在URL上进行拼接 POST传输的数据存储在Requst Body(请求体)中2.http请求中的Content-Typehttp的请求头和响应头中都有Content-Type字段,这个字段向我们说明了请求和响应的HTTP body(请求体或响应体)存储了什么类型的数据，然后客户端和服务端就可以根据http头部得Content-Ty...
Swagger字段属性说明不显示
qq_33240556的博客
05-23 1651
解决此问题的一般步骤是先检查模型类上的注解是否完整且正确，然后检查Swagger的配置，最后考虑是否存在版本兼容性或前端显示问题。：有时候问题可能不在后端配置，而是前端Swagger UI的显示问题。：如果使用了特定的JSON序列化库（如Jackson或Gson），确保它们的配置没有无意间排除了Swagger需要的元数据。：确保在模型类（实体类）的字段或getter/setter方法上使用了Swagger提供的注解来提供描述信息。：检查Swagger配置是否正确开启了模型属性的展示。
若依框架在swagger文档中无法显示响应参数和响应示例的问题
m0_50707445的博客
04-02 2133
若依
@RequestBody不生效，获取不到数据
xiaoxiao48的博客
11-08 2265
@RequestBody不生效，获取不到数据
swagger实体模型没有注释
tanyz114的博客
07-10 2112
swagger实体模型没有注释 将生成xml文件属性设置为“始终复制”即可
解决Swagger 添加了@ApiModel注解 在文档中不显示对象问题
m0_55584658的博客
08-17 2264
解决Swagger 添加了@ApiModel注解在文档中不显示对象问题
【RuoYi-Vue-Plus】问题笔记 02 - Knife4j | Swagger 文档页面空白 以及 文档参数无法显示问题
热门推荐
MichelleChung的星球
04-07 1万+
数据库注释引起的接口文档血案。
解决java方法中添加两个@RequestBody注解参数，swagger传参报错的问题
水巷石子的博客
03-25 7173
解决java方法中添加两个@RequestBody注解参数后，swagger传参报错的问题。 查资料后，发现一个方法参数中只能使用一个@RequestBody注解。 最终是将两个json合并为一个，嵌套方案解决。 最终代码中根据名称，获取对应的json串。
带@RequestBody参数如何在swagger中进行测试
07-11
在Swagger中测试带有@RequestBody参数的请求，可以通过以下步骤进行： 1. 在Swagger的API文档中找到相应的请求接口。 2. 点击该接口，在右侧的参数列表中找到带有@RequestBody注解的参数。 3. 点击参数旁边的...
评论 33
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值