如何生成离线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本身有一些工具可以让你生成离线/静态文档:

• 该扬鞭编辑器在上市生成文档的几种方法生成客户端菜单
• 该扬鞭代码生成模块,可以生成静态和动态的HTML文档

它们都需要Swagger YAML或JSON文件.如果您使用的是Spring,则YAML/JSON中没有Swagger定义,您可以使用生成的文件用于Swagger UI(/v2/api-docs?group=<group name>).

Answer 2

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

该工具是" Swagger2Markup ",位于@ Github.

"Swagger2Markup"的输出可以用作swagger-ui的替代品,可以作为静态内容使用.

这是一个例子

祝好运!:)