swagger-ui生成离线接口文档

本文分享了一种通过Swagger-UI提供的JSON数据生成离线文档的方法,包括源码获取及使用步骤,适用于希望本地化API文档的开发者。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

今天使用swagger-ui查看后台接口时发现swagger-ui提供了json数据,但没有提供生成离线文档的地方。

后来自己找了个通过json数据生成doc离线文档的源码,本着互相学习的初衷,这里分享给大家:

1.首先放上共享网盘地址:

链接:https://pan.baidu.com/s/1eOciORj5PsQfzRwSV5segg 
提取码:xysv 

2.我这里使用tomcat8、jdk8,放入war包到tomcat并启动成功后访问:http://localhost:8080/SwaggerToWord/

3.将swagger-doc地址复制到下面输入框中并点击提交:

4.打开下载后的doc文件如下:

<think>嗯,用户想了解如何使用Swagger生成离线接口文档。我之前收集了几个相关的引用,可能需要先梳理一下这些信息。首先,引用[1]提到导出Swagger2的离线API文档,用户的项目需要给前端联调,但需要离线版本。引用[2]中用户尝试了swagger2markup但遇到依赖问题,转而使用swagger.json转换的方法。引用[3]和[4]则推荐了SwaggerOfflineDoc工具和TableGo,特别是支持Word和Markdown格式。 用户可能不太熟悉这些工具的具体步骤,所以需要分步骤说明。首先,可能需要介绍几种不同的方法,比如使用Swagger UI生成JSON再转换,或者使用第三方工具。然后,针对每种方法给出具体的操作步骤,比如如何导出swagger.json,如何用SwaggerOfflineDoc生成文档,或者如何使用TableGo生成Word文档。同时,用户可能会关心工具的配置和使用教程,需要详细说明每一步,比如安装依赖、执行命令等。 另外,用户可能遇到常见问题,比如依赖错误或格式问题,需要给出解决方案。例如,引用[2]提到swagger2markup的问题,可能需要建议替代方案。还要注意引用对应的来源,确保信息准确。最后,生成相关问题可以帮助用户进一步探索,比如不同工具的比较或如何处理复杂API结构。需要确保回答结构清晰,步骤详细,同时保持自然的中文表达。</think>### 如何用Swagger生成离线接口文档? 以下是基于不同工具和方法的详细步骤,帮助您高效生成Swagger离线接口文档--- #### **方法一:通过Swagger UI导出JSON/YAML并转换** 1. **获取Swagger描述文件** 访问在线Swagger UI页面(如`http://localhost:8080/swagger-ui.html`),找到Swagger的JSON/YAML描述文件地址(通常为`/v2/api-docs`),通过浏览器直接下载`swagger.json`文件[^2][^4]。 2. **使用转换工具生成文档** - **SwaggerOfflineDoc工具**(推荐) 下载[SwaggerOfflineDoc](https://gitcode.com/gh_mirrors/sw/SwaggerOfflineDoc),运行以下命令生成HTML/Word文档: ```bash java -jar swagger-offline-doc.jar -i swagger.json -o output.html -t html ``` [^3] - **第三方在线转换器** 将`swagger.json`上传至[APIMatic](https://www.apimatic.io/)或[Swagger2Postman](https://www.postman.com/)等平台,导出为PDF/Markdown格式。 --- #### **方法二:使用TableGo生成Word/Markdown文档** 1. **配置TableGo** 下载[TableGo](https://tablego.jline.com.cn/)工具,在配置文件中指定Swagger的JSON文件路径和输出格式(Word或Markdown)。 2. **执行生成命令** ```bash java -jar tablego.jar -config swagger-config.yaml ``` 生成后的文档可直接交付客户,支持自定义模板调整样式。 --- #### **方法三:Swagger2Markup(需Maven/Gradle支持)** 1. **添加Maven插件依赖** 在`pom.xml`中添加: ```xml <plugin> <groupId>io.github.swagger2markup</groupId> <artifactId>swagger2markup-maven-plugin</artifactId> <version>1.3.3</version> <configuration> <swaggerInput>http://localhost:8080/v2/api-docs</swaggerInput> <outputDir>docs/</outputDir> </configuration> </plugin> ``` 2. **生成AsciiDoc/Markdown** 执行命令: ```bash mvn swagger2markup:convert ``` 生成文档可通过AsciiDoctor进一步转成PDF。 --- ### **常见问题解决** - **依赖加载失败**:检查Maven仓库镜像配置,或改用无需编译的工具(如SwaggerOfflineDoc)[^2]。 - **JSON格式错误**:使用[Swagger Editor](https://editor.swagger.io/)验证`swagger.json`的合法性。 ---
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值