如何生成离线 Swagger API 文档？

Posted 2023-02-27

【中文标题】如何生成离线 Swagger API 文档？

【英文标题】：How to generate offline Swagger API docs?

【发布时间】：2016-05-01 07:16:30

【问题描述】：

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

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

【参考方案1】：

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

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

Swagger Editor 在

生成客户端

菜单中列出了几种生成文档的方法 Swagger Codegen 模块允许您生成静态和动态 HTML 文档

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

【讨论】：

当合同被定义并且需要生成 swagger yml 或 swagger.html 时，这两个选项都不能帮助解决原始案例

【参考方案2】：

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

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

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

Here is an Example

祝你好运！ :)

【参考方案3】：

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

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

【参考方案4】：

打开现场大摇大摆的 HTML。点击展开所有操作。然后将 HTML 保存为 PDF。

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

【参考方案5】：

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

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

【参考方案6】：

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

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