如何生成离线 Swagger API 文档?

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

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


答案 1

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

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

  • Swagger 编辑器具有多种生成文档的方法,这些方法列在“生成客户端”菜单中
  • Swagger Codegen 模块允许您生成静态和动态 HTML 文档

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


答案 2

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

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

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

下面是一个示例

祝你好运!:)


推荐