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

问题描述

我正在使用 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 文件夹中的文件放在您的网络服务器上。

也可以embed Swagger UI进入您现有的网页，例如如果您想拥有自定义品牌页眉和页脚。

另见：

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