关于swagger2请求参数不显示问题

原创 已于 2023-11-14 12:40:12 修改 · 1w 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #springboot

于 2021-12-23 10:35:46 首次发布

在使用swagger2时遇到这样一种情况，在请求参数的实体类上已经写有注解@ApiModel，实体类中的每个字段也写有注解@ApiModelProperty，但是在swagger-ui界面却不显示请求参数。

引起这个问题的原因是在@ApiModel注解参数中写入了特殊字符“反斜线”，去掉"/"便可以显示请求参数。
SpringBoot中集成海康威视SDK实现布防报警数据上传/交通违章图片上传并在linux上部署(附示例代码资源)
BADAO_LIUMANG_QIZHI的博客
06-27 3273
需对接海康威视交通产品中的交通违章检测功能，实现车辆闯红灯时获取抓拍数据(车牌号)并获取上传的抓拍图片。根据其官方资料设备网络SDK使用手册中说明，此流程需要可以通过报警布防方式进行。访问官方下载SDK文档等资料服务支持-技术支持-SDK下载-选择设备网络SDK，这里服务器使用的centos，所以下载设备网络SDK_Linux64版本的下载之后会有需要引入的sdk文件以及说明手册、示例代码等。根据手册说明，方式可选为两种，这里选择报警布防方式，该方式可以接受上传的图片。
百度百度白百度 Swagger配置Model但接口不显示描述信息的，响应参数名称不同Java
TechRoar的博客
09-03 1056
通过正确配置Swagger的注解和附加的配置，我们可以确保生成的API文档中能够正确显示Model的描述信息和参数名称。在使用Swagger进行API文档生成时，有时候可能会遇到以下问题：配置了Swagger的Model，但是在生成的API文档中，接口没有显示描述信息，而且响应参数的名称与预期不符。然而，有时候即使正确配置了Model的注解，Swagger仍然无法正确显示描述信息和参数名称。这些配置可以帮助Swagger正确扫描到Model的注解，并将其显示在生成的API文档中。在上述配置中，我们添加了。
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
紧急规避！Swagger暴露敏感接口的4大安全隐患及应对策略
最新发布
PixelGlow的博客
10-14 1029
解决Java接口文档Swagger安全隐患，详解4大风险及应对策略。适用于Spring Boot项目，涵盖权限控制、敏感接口屏蔽等核心方法，保障API安全，值得收藏。
Swagger2的坑 请求参数不能显示
Amelia_Liu的博客
05-19 3921
问题：跟前端之前调的时候都还有请求参数的显示，后面突然好几个都没有了，真的真的很离谱 解决：引起这个问题的原因是在@ApiModel注解参数中写入了特殊字符“反斜线”，去掉"/"便可以显示请求参数。 我想用来对象公用 就加了注释为反斜杠，导致之前也不能显示，百度后一改为顿号就OK啦 ...
Swagger字段属性说明不显示
qq_33240556的博客
05-23 3298
解决此问题的一般步骤是先检查模型类上的注解是否完整且正确，然后检查Swagger的配置，最后考虑是否存在版本兼容性或前端显示问题。：有时候问题可能不在后端配置，而是前端Swagger UI的显示问题。：如果使用了特定的JSON序列化库（如Jackson或Gson），确保它们的配置没有无意间排除了Swagger需要的元数据。：确保在模型类（实体类）的字段或getter/setter方法上使用了Swagger提供的注解来提供描述信息。：检查Swagger配置是否正确开启了模型属性的展示。
SWAGGER3请求参数不显示
07-07
在 Swagger3 中，接口请求参数未显示的问题通常与注解使用、配置方式或特定实现框架（如 Springdoc OpenAPI）的兼容性有关。以下是可能导致请求参数未显示的原因及解决方法： ### 请求参数类型未正确标注 Swagger3 ...
Spring Boot进阶(17)：Swagger2高级配置：定制header请求头等参数
热门推荐
**My Coding Family**
04-14 1万+
如何在swagger2中配置header请求头等参数信息？你若不会，我手把手教你好了。
swagger ApiModelProperty 请求参数有些不显示
04-26
2. Swagger配置问题：请检查你的Swagger配置文件，确保已经正确启用了请求参数的显示功能。通常，你需要在Swagger配置文件中设置`enable`属性为`true`，以显示请求参数。 3. 编译问题：如果你在编译代码出现了错误...
springboot+swagger2文档从swagger-bootstrap-ui更换为knife4j及文档接口参数不显示问题
DN金猿的博客
07-12 231
摘要：本文介绍了将SpringBoot项目中Swagger2+swagger-bootstrap-ui升级替换为Knife4j的详细方案。主要变更包括：1）替换Maven依赖，采用Knife4j 2.0.9版本而非3.x版本以避免兼容性问题；2）修改配置文件前缀从swagger变为knife4j；3）调整配置类注解，将@EnableSwaggerBootstrapUI和@EnableSwagger2替换为@EnableKnife4j和@EnableSwagger2WebMvc。该方案保留了原有Swagger
若依框架在swagger文档中无法显示响应参数和响应示例的问题
m0_50707445的博客
04-02 4329
若依
Swagger2，UI文档不显示接口请求参数的问题
qq_32681589的博客
08-31 4962
Swagger2，UI文档不显示接口请求参数的问题 RT，因为之前没使用过Swagger，连API都不是很熟悉， 在接受前任的代码中，意外发现很多接口不显示请求参数的内容，只有一个参数类型，和名字，但是里面具体的参数完全不显示。 一开始还以为是因为自己不熟悉的原因所以没办法准确找到解决答案，于是我开始换发型，去洗手间洗手，百度API使用的正确姿势，但无论怎么变换姿势，还是没能正确显示出来。 于是我渐渐失去耐心，开始往”Swagger不显示请求参数“的方向努力，发现不少人吐槽遇到各种奇葩问题，各种小数点，莫名
Swgagger 不显示返回参数注解
xiaoerbuyu1233的博客
12-25 1289
AjaxResult不标准也不显示比如继承map实现。解决方案:data换成泛型。
Swagger的参数说明显示不了或显示不完全的问题
lzxA304的博客
01-23 4782
Swagger的参数说明显示不了或显示不完全的问题： 有可能是因为使用Lombok的@Data属性去省去写get,set造成的，将@Data属性去掉，手动添加get,set方法就解决了。
swagger（springfox）统一对象返回值 字段属性说明不显示
qq_40202111的博客
03-27 1303
首先确认返回对象是否 使用泛型来返回，如： 然后就是返回controller层是否有返回 如果以上都没有问题就是springfox的一个bug，在2.0.6等后面的高版本中由于升级了Springfox基础组件，如果我们使用到JRebel这类热加载插件的时候，会出现类字段没有的情况，目前没有办法解决springfox项目与JRebel插件的冲突，唯一的办法就是原来的debug启动
正常配置java实体 swagger 返回参数不显示
向着太阳微笑
10-14 1万+
2020年10月14日15:53:46 一个神坑问题！ 正常配置swagger注解结果不显示返回参数； 实体： controller: 结果返回参数么有显示！！！！！ 经过多次尝试，对比最后发现问题所在，单没搞明白为啥！ 这里我的注解@ApiModel("淘金广场App端接收对象V1.10") ; 问题就在这个V1.10上，是不是swagger不允许出现1.10的小数点；去掉后就正常了！ 结果正常出现，只是把“.10”删除了！！！！ ...
swagger的请求参数不显示,@Apimodel的坑点
weixin_44443569的博客
03-03 6509
目前遇到一个坑,swagger里面的post请求入参没有展示 如下图所示 问题产生: Apimodel里面带上了/ 导致swagger无法转换或者识别 解决:去除/或者相对应的特殊字符
解决Swagger文档中请求参数和响应参数都为空的bug
nian1983781的博客
08-06 2006
摘要：Swagger文档未显示对象内部属性的问题排查过程。通过检查Swagger配置、注解使用和Result类定义均未发现问题，最终发现是application配置中启用了Bean懒加载（spring.main.lazy-initialization: true）导致Swagger无法正确扫描模型类。关闭该配置后，Swagger文档恢复正常显示对象属性。问题根源在于Spring懒加载机制影响了Swagger的模型扫描功能。
swagger2不显示问题记录
IT_legendH的博客
05-23 405
虽然解决了但是问题的原因还是不清楚，去网上搜基本上都是一样的回答，改包扫描路径，检查注解，在这里做个记录。今天自己新建了一个boot项目，发现配置的swagger始终不显示类和方法。按照网上搜的排查了扫描包配置，注解等等都不解决问题。然后在配置文件里加上这行代码后问题解决。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值