如何生成离线 Swagger API 文档？

Question

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

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

原文由 code 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

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

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

• Swagger Editor 有多种生成文档的方法，列在 Generate Client 菜单中
• Swagger Codegen 模块允许您生成静态和动态的 HTML 文档

它们都需要 Swagger YAML 或 JSON 文件。如果您因为使用 Springfox 而在 YAML/JSON 中没有 Swagger 定义，则可以使用生成的用于 Swagger UI 的文件 ( /v2/api-docs?group=<group name> )。

原文由 g00glen00b 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

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

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

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

这是一个例子

祝你好运！ :)

原文由 Sahar Menashe 发布，翻译遵循 CC BY-SA 3.0 许可协议