时间戳

首页 > 解决方案 > Swagger-UI 可以做多少修改

swagger - Swagger-UI 可以做多少修改

问题描述

我有一些关于 swagger-ui 的问题。我已经从这里下载了 swagger-ui并使用了 index.html 并尝试修改它。据我了解，UI 是基于开放 api 规范文档以 yaml 或 json 文件格式动态生成的。我的问题如下

  1. 可以对 Swagger 生成的 UI 进行多少修改？
  2. 可以修改“试用”功能以获得更多控制权吗？我想要做的是有几个不是由 swagger 生成的输入字段，并将它们用作 api 调用的输入，使 UI 在本质上更具动态性。
  3. Swagger-UI 是否依赖于任何类型的 API 网关来调用 api 端点？

谢谢，

萨利尔

标签： swaggerswagger-ui

解决方案

可以对 Swagger 生成的 UI 进行多少修改？

Swagger UI 可以通过 JS 或 CSS 以非常不同的方式进行调整。

你可以看看https://swagger.io/docs/open-source-tools/swagger-ui/customization/overview/

可以修改“试用”功能以获得更多控制权吗？我想要做的是有几个不是由 swagger 生成的输入字段，并将它们用作 api 调用的输入，使 UI 在本质上更具动态性。

你应该看看我上面分享的链接，但不确定这是否可行。

如果我必须做这样的事情，我宁愿先看看如何完成原始 OpenAPI 定义（yaml/JSON 文件），然后再将其传递给 Swagger UI。

请注意，Swagger UI 中还有一个“拦截器”功能，例如允许在发送请求之前修改请求。这可能会让你感兴趣。

Swagger-UI 是否依赖于任何类型的 API 网关来调用 api 端点？

一点也不。Swagger UI 只是使用您的浏览器在 OpenAPI 文件记录的 URL 处调用 API。

推荐阅读