解决Swagger UI示例值显示"string"的问题

最近在使用ObjectScript生成JSON接口文档时，遇到了一个奇怪的问题：

  • 生成的JSON数据是正常的。

  • 但Swagger UI的Example Value却显示为"string"，而不是预期的JSON结构。

经过一番排查，我发现问题的根源在于Swagger UI的版本问题，并成功找到了解决方案。这里分享我的思考过程，希望能帮到有类似困扰的朋友。

排查过程

1. 确保生成的JSON数据正确

最开始，我怀疑是代码逻辑有误，导致生成的JSON格式不对。然而，当我把生成的JSON复制到Swagger Editor中时，发现它能正确解析，这说明JSON本身是正确的。

这让我意识到，Swagger UI可能是自动补全了正确的 OpenAPI/Swagger 版本信息，从而正常显示JSON数据。

2. 怀疑Swagger UI版本问题

既然JSON数据是正确的，那问题可能出在Swagger UI的版本上。我回顾了自己的环境，发现Swagger UI的版本是5.11.0。

    <head>

        <meta charset="utf-8"/>

        <meta name="viewport" content="width=device-width, initial-scale=1"/>

        <meta name="description" content="SwaggerUI"/>

        <title></title>

        <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui.css"/>

    </head>

于是，我尝试直接修改生成的HTML文件，将Swagger UI的版本从5.11.0升级到5.20.0（即最新版本），然后重新加载页面，结果问题完美解决！

3. 发现官方修复记录

随后，我在Swagger UI的官方Release Notes中找到了相关修复记录。

原来，在5.11.10版本中，Swagger UI修复了这个Bug。

这也进一步验证了我的猜测：问题并非出在我的代码，而是Swagger UI在旧版本中的Bug导致Example Value无法正确显示。

经验总结

  1. 不要太相信AI工具。我问了gpt4和claude3.5都3.7，一直给我乱改代码，找不到原因。
  2. 遇到问题，思路要开放。不要一开始就怀疑自己的代码，可能是外部工具或库的问题。
  3. 检查工具版本。当出现未知问题时，尝试更新到最新版本，或查阅官方Release Notes，可能Bug早已被修复。
  4. 直接修改生成的HTML。在无法确定问题来源时，直接编辑最终生成的文件，能更直观地测试不同版本的影响。

希望这篇文章能帮助到有类似困扰的朋友，也欢迎大家分享自己的调试经验！

Swagger OpenAPI Schema 为空时 Example Value 显示 "string" 的原因及解决方案的更多相关文章

  1. asp:Repeater数据源为空时处理方式

    当Repeater的数据源为空时,会显示空白,界面不友好,以下方式可以简单处理. <asp:repeater runat="server" id="rplist2& ...

  2. Swagger/OpenAPI By Swashbuckle在NetCore 3.1中较NetCore 2.2使用的注意事项及入门

    方案选择 使用Web API时,了解其各种方法对开发人员来说可能是一项挑战. Swagger也称为OpenAPI(Open Application Programming Interface,开放应用 ...

  3. 服务器通信REST、gRPC，Swagger/OpenAPI

    服务间的通信方式是在采用微服务架构时需要做出一个最基本的决策.默认的选项是通过 HTTP 发送 JSON,也就是所谓的 REST API.我们也是从 REST 开始的,但最近我们决定改用 gRPC. ...

  4. 服务器通信REST、gRPC，Swagger/OpenAPI，Consul

    服务间的通信方式是在采用微服务架构时需要做出一个最基本的决策.默认的选项是通过 HTTP 发送 JSON,也就是所谓的 REST API.我们也是从 REST 开始的,但最近我们决定改用 gRPC. ...

  5. VB6.0中，DTPicker日期、时间控件不允许为空时，采用文本框与日期、时间控件相互替换赋值（解决方案）

    VB6.0中,日期.时间控件不允许为空时,采用文本框与日期.时间控件相互替换赋值,或许是一个不错的选择. 实现效果如下图: 文本框txtStopTime1 时间框DTStopTime1(DTPicke ...

  6. [WPF]ComboBox.Items为空时，点击不显示下拉列表

    ComboBox.Items为空时,点击后会显示空下拉列表: ComboBox点击显示下拉列表,大概原理为: ComboBox存在ToggleButton控件,默认ToggleButton.IsChe ...

  7. esayUi中datagrid中json串为空时，显示上一次数据的解决方法

    function initSearchProject(startDate,finishDate,flag) {        $("#finishDate").val(finish ...

  8. easyUI draggable插件使用不当，导致拖动div内部文本框无法输入；设置echarts数据为空时就显示空白，不要动画和文字

    先上一个Demo <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://ww ...

  9. IE9或以上的浏览器flash值为空时，导致domready不触发

    在前些时间开发中遇到一个问题当flash值<param name="movie" value=""/>为空时,IE版本>=9不会触发domre ...

  10. 如何让listview列表为空时显示提示

    先在布局文件中声明一个TextView,再设置listview.setEmptyView(TextView).这样当listview中的数据为空时就会列表的位置就会显示textviw中的提示.

随机推荐

  1. T 语言语法设计方案总结

    早在 2015,我就已经精通了 C++.C#.JS,也用过其它语言,比如 PHP.Python.Java 做过一些项目,就觉得这些语言设计得太过复杂.坑多.麻烦,所以就开始设计一门新语言,暂且叫 T ...

  2. 【NAS】Docker Gitea+SakuraFrp+绿联DPX4800标 搭建私有代码托管平台

    本文主要分享 Gitea的一些设置,和Https的实现. Gitea的一些设置 映射 网络 HTTPS的实现 先准备好一个域名,建议准备一个1Panel 创建一个AC账户然后点击申请证书,手动解析. ...

  3. Shell_Shell 脚本中字符串的相关操作

    在我们的shell 编程中,一个必不可少的操作就是针对于字符串的操作, 重要有字符串替换,计算字符串长度 等等... 原文地址: https://blog.csdn.net/github_337369 ...

  4. idea中terminal的配置

    idea中terminal的配置流程: File->settings->Tools->terminal 然后根据需要进行配置: 显示git操作界面 Shell path ==> ...

  5. Netty系列之Netty安全性

    1.1. 严峻的安全形势 1.1.1. OpenSSL Heart bleed漏洞 2014年上半年对网络安全影响最大的问题就是OpenSSL Heart bleed漏洞,来自Codenomicon和 ...

  6. mybatis-plus多表联合分页查询

    1.entity层要写个Vo实体类 2.controller @AutoLog(value = "员工CURD-分页列表查询")@ApiOperation(value=" ...

  7. Spring Validation 校验

    概述 在 Web 应用中,客户端提交数据之前都会进行数据的校验,比如用户注册时填写的邮箱地址是否符合规范.用户名长度的限制等等,不过这并不意味着服务端的代码可以免去数据验证的工作,用户也可能使用 HT ...

  8. 【原创】利用gitlab多项目自动部署到多个网站目录，自动同步更新，不用插件，重写钩子

    原创内容,分享请保留链接. 0.首先在服务器安装gitlab,网上一堆过程省略 1.建几个空仓库admin.web.xxxx等(1个仓库也行).确保每个仓库名称和网站名称要有一致性,比如仓库叫admi ...

  9. Qt编写安防视频监控系统42-用户权限

    一.前言 前几年写这个视频监控系统的时候,就规划过要加入用户权限管理,因为不属于急需要的功能一直耽搁至今,近期刚好其他几个项目要需要这个功能,和秘钥认证一样,于是一鼓作气就把这几个功能一块干掉,本次完 ...

  10. [转]基于GMap.Net的地图解决方案

    一 地图的加载与显示 关于GMap的介绍与使用可以看我以前的文章: GMap.Net开发之在WinForm和WPF中使用GMap.Net地图插件 GMap.Net是.Net下一个地图控件,可以基于Ht ...