如何生成离线 Swagger API 文档？

How to generate offline Swagger API docs?

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

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

您可以在 https://editor.swagger.io. For any issue/feedback with the static doc, please report in the Swagger Codegen Github 存储库的 "Generate Client" 菜单下尝试 "HTML" 或 "Dynamic HTML"。

editor.swagger.io 利用 https://generator.swagger.io 生成代码，generator.swagger.io（Swagger 生成器）是 Swagger Codegen 项目的一部分。

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

Swagger 本身有一些工具可以让您生成 offline/static 文档：

Swagger Editor 在生成客户端 菜单
Swagger Codegen 模块允许您生成静态和动态 HTML 文档

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

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

Here 是门户网站 API 的一个示例，其中包含关于其 API 之一的文档。

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

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

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

Here is an Example

祝你好运！ :)

Pretty-swag 是 UI Swagger 规范 V2，能够生成静态 HTML 其他格式。它的灵感来自 Swagger Editor。

结帐https://github.com/twskj/pretty-swag

开启live swaggerHTML。单击展开所有操作。然后将 HTML 另存为 PDF。

这应该会给你一个像样的 PDF API 文档，里面有所有的细节。

如何生成离线 Swagger API 文档？

How to generate offline Swagger API docs?

java

spring-mvc

spring-boot

swagger

springfox