Swagger2，UI文档不显示接口请求参数的问题

最新推荐文章于 2024-04-15 15:19:43 发布
最新推荐文章于 2024-04-15 15:19:43 发布
阅读量4.3k 收藏 1
点赞数
分类专栏： Java 文章标签： swagger2 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_32681589/article/details/120018656
版权

Swagger2，UI文档不显示接口请求参数的问题

RT，因为之前没使用过Swagger，连API都不是很熟悉， 在接受前任的代码中，意外发现很多接口不显示请求参数的内容，只有一个参数类型，和名字，但是里面具体的参数完全不显示。

一开始还以为是因为自己不熟悉的原因所以没办法准确找到解决答案，于是我开始换发型，去洗手间洗手，百度API使用的正确姿势，但无论怎么变换姿势，还是没能正确显示出来。
于是我渐渐失去耐心，开始往”Swagger不显示请求参数“的方向努力，发现不少人吐槽遇到各种奇葩问题，各种小数点，莫名的符号，导致的无法显示。
经过上面的“抽风”点拨，我的脑回路也开始往抽风方面想。最后神奇的一幕出现了，原来是我请求的Controller页面，即@ApiImplicitParam直接标注的方法里头，多了个todo注释导致的！！！ 删除后终于显示正常了
怕怕~~
在这里插入图片描述

验证码有毒
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
专栏目录
swagger文档以及knife4j文档
04-02
通过SpringBoot集成Api文档（Swagger文档）和（knife4j文档）。启动项目后 Swaggger文档访问地址：localhost:8888/swagger-ui.html knife4j文档访问地址:localhost:8888/doc.html
集成Swagger2，接口文档不显示
strggle_bin的博客
01-24 818
swagger的首页可以显示，就是不显示接口。配置类上添加：@EnableWebMvc。
关于swagger2请求参数不显示问题
我有一枚大大大太阳
12-23 9014
在使用swagger2时遇到这样一种情况，在请求参数的实体类上已经写有注解@ApiModel，实体类中的每个字段也写有注解@ApiModelProperty，但是在swagger-ui界面却不显示请求参数。 引起这个问题的原因是在@ApiModel注解参数中写入了特殊字符“反斜线”，去掉"/"便可以显示请求参数。 ...
Swagger入参显示问题
a20100997的博客
06-21 1498
今天发现了一个小问题，我写了一个post接口，入参用requestBody接收，但前端调用时发现有个参数接收不到，最后定位到是大小写的问题。我仔细查看swagger的接口文档，发现swagger存在bug：有一些参数我明明是驼峰命名，但是swagger却显示的和定义的不一致⬇️。经过搜索可能是lombok的@Data注解的问题，但代码已经写完，实在懒得改成getter和setter。
nutz-swagger json/yaml页面报错 参数不显示等
qq_43338400的博客
10-14 467
nutz-swagger json/yaml走过的坑 另，有错误的地方也请大家指出来，共勉。 文章目录nutz-swagger json/yaml走过的坑不多说废话，大牛的样例一、页面报错1、 url，json格式也可以写成是yaml格式，即./swagger.yaml。2、包路径，是swagger接口路径，有swagger注解的类二、参数不显示三、超时报错1.考虑是拦截的问题2.缺少commons-lang3-3.9jar总结 不多说废话，大牛的样例 https://github.com/nutza
Swagger2的坑 请求参数不能显示
Amelia_Liu的博客
05-19 3338
问题：跟前端之前调的时候都还有请求参数的显示，后面突然好几个都没有了，真的真的很离谱 解决：引起这个问题的原因是在@ApiModel注解参数中写入了特殊字符“反斜线”，去掉"/"便可以显示请求参数。 我想用来对象公用 就加了注释为反斜杠，导致之前也不能显示，百度后一改为顿号就OK啦 ...
Swagger3接口文档显示参数错误问题
m0_53788761的博客
04-18 4923
问题1：接口文档不显示我们Form中的参数信息，直接就是一片空白，大多出现在添加编辑这样的接口中。 解决办法：将controller和form下的swagger注解中value参数内容去掉"-"或者"/"，使用全文字描述； 原因：Swagger注解会识别特殊符号“-”或者“/”，导致显示出问题。 问题2：接口文档显示的参数并不是我们在Form中定义的，例如：我们在Form中没有定义分页参数，但是文档中有分页参数。 解决办法：修改Form下的swagger注解中的valu..
【RuoYi-Vue-Plus】问题笔记 02 - Knife4j | Swagger 文档页面空白 以及 文档参数无法显示问题
热门推荐
MichelleChung的星球
04-07 1万+
数据库注释引起的接口文档血案。
Swagger2.0不显示文档参数
qq_40886696的博客
04-10 1038
description=“模块名称”，需要指定好，直接默认字符串不行的，模式是value。@ApiModel(description=“模块名称”)
swagger注解（@ApiModelProperty）实体类swagger-ui不显示问题
zhangwenchao0814的博客
05-13 7263
实体类首字母必须小写，否则swagger-ui界面显示对象的参数说明不显示、是否必输属性即使指定必输也是显示false；比如数据库中字段为B_WORKDAYFLAG，使用mybatis-plus代码生成器工具生成后是bWorkDayFlag，此时可以在mybatis-plus代码生成器中设置生成实体类时去掉字段前缀，如： strategy.setFieldPrefix("B_", "C_", "D_", "VC_"); //生成实体时去掉字段前缀 *** 代码*** public static void
swagger-hack:自动化爬取并自动测试所有swagger-ui.html显示的接口
03-05
招摇 在测试中偶尔会碰到swagger附加的常见的对齐方式： 有的同轴接口特别多，每一个都手动去试根本试不过来随后用python写了个脚本自动爬取所有接口，配置好传参发包访问 原理是首先抓取获取到一些标准和对应的文档地址而后对每个标准下的接口文档进行解析，构造请求包，获取响应 尽量考虑到了所有可能的传参格式，实际测试只有少数几个会500或400响应需要手动修改一下，其余都是401或200 200就是未授权访问接口了，可以进一步做其他诸如sqli等测试运行时然后： 所有测试结果都存储在csv中： 欢迎大家关注稻草人安全团队，后续有更多技术文章，工具分享等
swagger-bootstrap-ui：Swagger-bootstrap-ui是Swagger的前端UI实现，目的是替换Swagger的默认UI实现Swagger-UI，使文档更加友好...
02-25
文档：根据Swagger的规范，列出了接口文档的详细说明，包括接口地址，类型，请求示例，请求参数，响应示例，响应参数，响应代码和其他信息。 通过使用swagger-bootstrap UI，它可以清楚地了解此接口的用法。 在线...
swagger-ui-plugins:Swagger UI v3的有用插件
05-07
随时打开问题并提出修复错误，添加功能和引入新插件的请求。 当/如果您的PR被接受，我将发布每个插件的版本。 如果您添加新的插件，请把自己添加到下面的“贡献者”列表中！ 版本控制 每个插件都使用进行版本控制...
项目API文档在线自动生成 Swagger UI.zip
07-19
Swagger UI是一款RESTFUL接口的文档在线自动生成 功能测试功能软件。 现在多数的项目开发中，网站和移动端都需要进行数据交互和对接，这少不了使用REST编写API接口这种场景。例如有些团队，移动端交由了另一团队...
aiohttp-swagger3:使用swagger规范3.0进行swagger文档浏览和验证aiohttp请求的库
05-03
用于通过不同的UI后端显示swagger文档以及使用swagger规范3.0（称为OpenAPI3）可选地验证/解析aiohttp请求的软件包。 支持的UI后端 如果仅需要验证而无法查看文档，则可以使用多个UI后端，或者可以完全禁用UI后端。 ...
java面向对象.day21（继承02--super）
BaiZhuYuan的博客
04-14 734
super===父this===当前使用super时，首先要继承父类，其次是在子类里面才能使用super。继承父类后，运行子类时会同时调用父类的构造方法，如果要显性调用父类的构造方法必须在子类的第一行调用。单使用super()表示调用父类构造方法，单使用this()表示调用本身的构造方法。父类具有有参的构造方法时，并且没有显性无参构造方法，那么子类要使用时必须直接调用父类的有参构造方法，
SpringBoot整合javaMail
weixin_62513677的博客
04-13 584
快速掌握springboot邮件的发送
常见Spring相关工具报错-源码分析
最新发布
小百的博客
04-15 394
在 getResources 中会获取 getResources(“classpath*:” + i18n/messages + “.properties”)，但是缺少messages.properties属性文件。3️⃣ 源码分析 MessageSourceAutoConfiguration 配置类。4️⃣ 解决：补充 messages.properties 文件。
C# Swagger-UI 接口调用类作为参数如何显示类的属性描述
06-07
在 C# Swagger-UI 中，如果要在接口调用中使用类作为参数，并且希望在 Swagger-UI 中显示类的属性描述，可以使用 XML 注释来描述类和属性，然后使用 Swagger-UI 提供的 `ApplyXmlActionFilter` 类来应用这些注释。 具体而言，需要在 `SwaggerConfig.cs` 文件中注册 `ApplyXmlActionFilter` 类，并在 `WebApiConfig.cs` 文件中启用注释功能。以下是示例代码： ```csharp // SwaggerConfig.cs public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuration .EnableSwagger(c => { // 设置 Swagger 文档信息 c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" }); // 使用 ApplyXmlActionFilter 应用 XML 注释 c.OperationFilter<ApplyXmlActionFilter>(thisAssembly); // 设置 Swagger JSON 和 UI 的路径 var xmlPath = GetXmlCommentsPath(); c.IncludeXmlComments(xmlPath); }) .EnableSwaggerUi(c => { // 设置 Swagger UI 的参数 }); } private static string GetXmlCommentsPath() { var basePath = AppDomain.CurrentDomain.RelativeSearchPath ?? AppDomain.CurrentDomain.BaseDirectory; var xmlPath = Path.Combine(basePath, "MyApi.xml"); return xmlPath; } } ``` ```csharp // WebApiConfig.cs public static class WebApiConfig { public static void Register(HttpConfiguration config) { // 启用注释功能 var xmlPath = HttpContext.Current.Server.MapPath("~/App_Data/MyApi.xml"); config.EnableSwagger(c => { c.SingleApiVersion("v1", "My API"); c.IncludeXmlComments(xmlPath); }); config.EnableSwaggerUi(); } } ``` 在使用类作为参数的接口中，需要使用 XML 注释来描述类和属性。以下是示例代码： ```csharp /// <summary> /// 用户类 /// </summary> public class User { /// <summary> /// 用户 ID /// </summary> /// <example>1</example> public int Id { get; set; } /// <summary> /// 用户名 /// </summary> /// <example>John</example> public string Name { get; set; } /// <summary> /// 用户邮箱 /// </summary> /// <example>[email protected]</example> public string Email { get; set; } } /// <summary> /// 更新用户信息请求类 /// </summary> public class UpdateUserRequest { /// <summary> /// 用户 ID /// </summary> /// <example>1</example> public int UserId { get; set; } /// <summary> /// 用户名 /// </summary> /// <example>John</example> public string Name { get; set; } /// <summary> /// 用户邮箱 /// </summary> /// <example>[email protected]</example> public string Email { get; set; } } public class UserController : ApiController { /// <summary> /// 更新用户信息 /// </summary> /// <param name="request">更新用户信息请求</param> /// <remarks>更新用户的姓名和邮箱</remarks> public void UpdateUser(UpdateUserRequest request) { // 更新用户信息的逻辑 } } ``` 在 Swagger-UI 中，就可以看到类和属性的描述信息了。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

验证码有毒

你的鼓励将是我创作的最大动力

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

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

打赏作者

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

抵扣说明：

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

余额充值