以与显示的样式相同的方式下载 swagger-documentation

Downloading swagger-documentation in the same style as displayed

我正在使用 swagger-editor docker。

它在右栏中生成我在右栏中编写的文档的美观且实用的交互式版本。

我正在尝试导出此类文档,但没有成功。

是否可以导出交互式、独立的文档,其外观和工作方式与右栏中所示的一样?

Swagger Editor 的右侧面板是Swagger UI。您可以下载 Swagger UI 资产并将它们托管在您自己的网站上。

  1. 下载(或克隆)Swagger UI 存储库:
    https://github.com/swagger-api/swagger-ui

  2. 进入 dist 文件夹 - 它包含静态资源。

  3. 将您的 OpenAPI YAML/JSON 文件放入 dist 文件夹。

  4. dist\index.html 文件中,将 url 参数更改为指向您的 YAML/JSON 文件:

          const ui = SwaggerUIBundle({
            url: "myapi.yaml",  // <----
    
  5. dist 文件夹中的文件放到您的网络服务器上。

也可以 到您现有的网页,例如如果您想要自定义品牌页眉和页脚。


另请参阅:

  • Is it possible to get an offline version of Swagger documentation for a website?