程序问答   发布时间:2022-06-01  发布网站:大佬教程  code.js-code.com
大佬教程收集整理的这篇文章主要介绍了如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。

如何解决如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面?

开发过程中遇到如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面的问题如何解决?下面主要结合日常开发的经验,给出你关于如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面的解决方法建议,希望对你解决如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面有所启发或帮助;

您所寻找的内容可以通过基本的Swagger-ui工具轻松完成。

本质上,您拥有的是许多摇摇欲坠的定义的列表。我猜您想让用户单击按钮或链接,或者从下拉菜单中选择定义以选择要查看的API。完成后,您可以执行以下操作:

  • 让用户选择要显示的API定义。您可以通过向其中添加@R_404_6832@元素index.@R_404_6832@在选择后触发一些JavaScript 来轻松实现
  • 单个swagger-ui容器可以重新加载和重用。从第一步获取到swagger定义的URL,并将其提供给swagger-ui对象,通常是这样完成的:
  • @H_944_13@

    window.swaggerUi.@R_616_9531@eSwaggerUi({url: 'http://your.spec.com/swagger.yaml'})

    现在,容器将重新加载您指定的规范。

    解决方法

    我正在尝试通过Swagger UI记录供公司内部使用的,由供应商产品(WSO2
    ESB)开发的现有API服务。供应商产品不支持摇摇欲坠。我计划以编程方式检查/处理我的API服务的源代码(用卖方产品编写),并生成.json或.yml格式的swagger定义文件的目录/文件夹/库。很好,我可以做到。

    这些API定义文件中的每一个都可以在swagger
    UI中很好地呈现,我正在使用https://www.npmjs.com/package/swagger-
    ui进行查看。

    我的问题是,我最终将获得大约100个这些API定义文件,我想提供一些概述界面/页面,其中列出了所有API,然后将用户带到Swagger
    UI,并在用户单击时加载了特定的API定义在链接之一上。这等效于打开我的本地swagger-
    ui并在相关API定义的路径中手动键入/复制。如果我手动执行此操作,则效果很好,只是我不希望用户手动执行此操作。他们将如何知道存在哪些API定义网址,以及为什么要手动键入/复制它们。

    我看不到如何将“ apiDefintionToLoad”参数传递给Swagger-ui,我想我要么找到一个参数,要么更改源代码以支持该参数。是否存在?

    是否有更好的解决方案,无论是自己发展还是使用现有的软件包或解决方案?我更喜欢基于节点的解决方案,java也可以。

    我要错了吗?

    谢谢,马特。

    大佬总结

    以上是大佬教程为你收集整理的如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面全部内容,希望文章能够帮你解决如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面所遇到的程序开发问题。

    如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。

    本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
    如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。
标签:/