c# - 是否有可能获得网站的 swagger 文档的离线版本？

Question

localhost/swagger 正在按预期加载，但 remoteserver/swagger 出现问题。我可以保存生成的 swagger 文档的离线副本吗？在尝试调试远程问题时，我可以将 zip 文件发送给几个用户。

Answer 1

如果您由于某种原因无法自己托管 Swagger UI，则有很多方法可以向您的用户提供 API 文档。所有建议都假设您有一个 OpenAPI (Swagger) 定义，即 YAML/JSON 文件。如果您不知道 YAML/JSON 文件的位置，您可以 infer it from the Swagger UI web page .
没有特定的顺序:

将 YAML/JSON 文件发送给您的用户并告诉他们在 http://editor.swagger.io 中加载它以便预览 API 文档。

将您的 OpenAPI 定义文件导入 SwaggerHub并在那里托管您的 API 文档。
披露:SwaggerHub 是由我工作的公司制作的。

将您的 OpenAPI 定义文件放在任何公共(public) Web 服务器上，例如create a gist在 GitHub 上。然后您可以通过将其加载到 Swagger UI 公共(public)演示中来呈现 API 文档，如下所示:

 http://petstore.swagger.io?url=YOUR_YAML_or_JSON_URL

如果使用要点，请确保指定原始要点链接 ( https://gist.githubusercontent.com/... )。如果使用其他主机，请确保主机服务器支持 CORS .

“打包” Swagger UI 和您的 OpenAPI 定义到一个无依赖文件中 as explained here ，并将生成的文件发送给您的用户。

生成静态 HTML 文档(不是 Swagger UI，而是没有“试用”的静态 HTML 页面):将您的 OpenAPI 定义加载到 http://editor.swagger.io ，然后选择菜单项 生成客户端 > html 或 html2 或 动态-html .

“生成客户端”功能使用 Swagger Codegen ，因此您还可以使用 Codegen 的 CLI 版本生成所需的输出。

想要PDF？可以到 convert OpenAPI definitions to PDF .

也可以看看:

Generate static docs with Swagger

Converting Swagger specification JSON to HTML documentation