是否有可能获得网站的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。

没有特别的顺序：

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

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

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

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

   如果使用要点，请务必指定原始要点链接（ https：//gist.githubusercontent.com / ... ）。如果使用其他主机，请确保托管服务器支持CORS。

4. ＆＃34;包＆＃34;将Swagger UI和您的OpenAPI定义整合到一个无依赖项文件as explained here中，并将生成的文件发送给您的用户。

5. 生成静态HTML文档（不是Swagger UI，而是一个没有＆＃34的静态HTML页面;试一试＆＃34;）：将您的OpenAPI定义加载到http://editor.swagger.io，然后选择菜单项< strong>生成客户端＆gt; html 或 html2 或动态-html 。

   ＆＃34;生成客户＆＃34;功能使用Swagger Codegen，因此您也可以使用Codegen的CLI版本来生成所需的输出。

6. 想要PDF吗？可以convert OpenAPI definitions to PDF。

另见：

• Generate static docs with Swagger
• Converting Swagger specification JSON to HTML documentation