如何生成离线Swagger API文档？

Question

我有一个Spring Boot MVC java Web应用程序。我已经能够集成Springfox for API文档。当服务器启动并运行时，我可以直观地看到所有API。

如何生成OFFLINE swagger API文档？注意：我不想使用asciidoc或markdown文档，但我喜欢html文件中相同的swagger API用户界面。我希望链接相对于本地目录而不是本地主机服务器链接。感谢

Answer 1

Springfox允许您根据Spring注释轻松创建Swagger测试器/ API文档。

Swagger本身有一些工具可以让你生成离线/静态文档：

• Swagger Editor有多种方法可以生成生成客户端菜单中列出的文档
• Swagger Codegen模块允许您生成静态和动态HTML文档

它们都需要Swagger YAML或JSON文件。如果您在使用Spring Fox时没有使用YAML / JSON中的Swagger定义，则可以使用生成的文件用于Swagger UI（/v2/api-docs?group=<group name>）。

Answer 2

Swagger拥有生成离线文档的工具。

该工具是“Swagger2Markup”，位于@ Github。

“Swagger2Markup”的输出可以用作swagger-ui的替代品，可以作为静态内容使用。

Here is an Example

祝你好运！ ：）

Answer 3

您可以在Swagger Codegen的“生成客户端”菜单下尝试“HTML”或“动态HTML”。有关静态文档的任何问题/反馈，请在https://generator.swagger.io Github回购中报告。

editor.swagger.io利用{{3}}生成代码，而generator.swagger.io（Swagger Generator）是Swagger Codegen项目的一部分。

Answer 4

打开实时swagger HTML。单击展开所有操作。然后将HTML保存为PDF。

这应该为您提供一个不错的PDF API文档，其中包含所有详细信息。

Answer 5

您可以查看https://www.DynamicApis.com。您可以创建API门户并上传swagger JSON文档。该站点采用Swagger文档，为您的API生成更好的用户界面以及一些非常酷的工具。

Here是一个门户API的示例，其中包含有关其中一个API的文档。