根据swagger.json生成离线api文档

关注

原创最新推荐文章于 2026-04-08 10:01:21 发布 6.1k 阅读 AI 写同款· GEO 优化 ›

springboot项目中利用poi将json导出成标准接口文档到word（swagger样式）根据业务需求需要，需要将json格式的api信息【比如postman导出接口文档这类的】，导出成标准接口文档的word文件。该平台是将一些好的第三方平台接口接入进来，供用户使用，每个用户下有可以使用的接口，可以根据需要，将这些api勾选导出成标准接口文档的样式。接到需求后呢，觉得应该不难啊，不就是导出吗，结果听完需求描述傻眼了，市面上并没有封装完全且符合需求的组件或者源码，就很头疼最终采用poi，手搓导出word。[真的痛苦] 4.2数据源json 4.3ExportWordUtil工具类 4 阅读详情

根据swagger.json生成离线api文档

支持url和 json文件生成

下载jar包

http://119.27.167.41:8080/books/8b0d7a7f2ec2b64983da98ed01061bc4/swagger2markup.jar

执行生成文档命令

根据swagger api url 生成

url 地址在浏览器开发者模式上找 api-docs结尾的url, 返回一大串json的url

C:\Users\chengdu\Desktop\swaggerdoc>java -jar swagger2markup.jar http://localhost:9090/v2/api-docs
json file location-----http://localhost:9090/v2/api-docs
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

根据swagger的api json文件生成

C:\Users\chengdu\Desktop\swaggerdoc>java -jar swagger2markup.jar D:/Others/api-docs-new-2.json
json file location-----D:/Others/api-docs-new-2.json
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

查看当前目录下会看到多了一个target文件夹, 文档位置在 \target\asciidoc\generated

C:\Users\chengdu\Desktop\swaggerdoc\target\asciidoc\generated>dir
 驱动器 C 中的卷没有标签。
 卷的序列号是 02BA-32EC

 C:\Users\chengdu\Desktop\swaggerdoc\target\asciidoc\generated 的目录

2019/04/14  22:41    <DIR>          .
2019/04/14  22:41    <DIR>          ..
2019/04/14  22:41             3,568 definitions.adoc
2019/04/14  22:41               416 overview.adoc
2019/04/14  22:41             8,807 paths.adoc
2019/04/14  22:41                 4 security.adoc
               4 个文件         12,795 字节
               2 个目录 209,610,186,752 可用字节