swagger转md或其他文档

本文介绍如何通过将Swagger接口页面转换为JSON,利用YAPI解析并生成定制化的接口文档,实现无需依赖后端服务的离线查看。
问题描述:

很多开发接入了swagger插件生成了对应的接口页面。但是每次查看接口的时候需要后端同学开启服务查看对应的swagger接口页面。所以我们想到将每次生成的swagger直接转换成word、md或者其他格式。

解决方案

1、打开对应的swagger页面,点击项目名称下方的链接。
在这里插入图片描述
打开链接会是一个内容为json格式的页面。将页面另存为json。

2、解析json文件为对应的文档

这里解析直接采用的yapi生成对应的模板;在yapi项目中直接新建项目,导入刚刚保存的json。就会生成新的swagger对应的接口项目。然后导出时选择自己需要的格式。

在这里插入图片描述
导出以后就是离线本地的漂亮的接口文档啦。

### 将 Swagger API 文档导出为 Markdown 格式的方法 将 Swagger API 文档导出为 Markdown 格式,通常可以通过使用 Swagger 提供的工具第三方库来实现。以下是几种常见的方法: #### 1. 使用 Swagger UI 的导出功能 Swagger UI 提供了一个简单的接口来查看和测试 API 文档。虽然 Swagger UI 本身不直接支持导出为 Markdown 格式,但可以通过以下步骤间接实现: - 首先,确保你的应用已经集成了 Swagger,并且可以通过 HTTP 访问 API 文档。 - 然后,使用 `swagger-cli` 工具从 Swagger UI 下载 JSON YAML 格式的 API 定义文件。 - 最后,使用 `swagger-markdown` 工具将 JSON YAML 文件换为 Markdown 格式。 ```bash # 安装 swagger-cli 和 swagger-markdown npm install -g swagger-cli swagger-markdown # 下载 Swagger JSON 文件 swagger-cli bundle http://localhost:8080/v2/api-docs --output swagger.json # 将 JSON 文件换为 Markdown swagger-markdown -i swagger.json -o api-documentation.md ``` #### 2. 使用 Swagger2Markup Swagger2Markup 是一个开源库,可以将 Swagger/OpenAPI 文档换为多种格式,包括 Markdown。它支持从 Swagger JSON YAML 文件生成 Markdown 文档。 ```bash # 安装 Swagger2Markup pip install swagger2markup # 将 Swagger JSON 文件换为 Markdown swagger2markup convert -i swagger.json -f api-documentation.md ``` #### 3. 使用在线工具 如果你不想安装任何工具,也可以使用在线工具来Swagger 文档为 Markdown 格式。例如,可以使用 [Swagger to Markdown](https://swagger2markup.github.io/swagger2markup/) 在线换工具。 - 打开在线工具网站。 - 上传你的 Swagger JSON YAML 文件。 - 选择输出格式为 Markdown。 - 点击换按钮,下载生成的 Markdown 文件。 #### 4. 使用 Spring Boot 集成 如果你的应用是基于 Spring Boot 的,可以使用 `springfox-swagger2` 和 `springfox-swagger-ui` 库来生成 API 文档,并通过 `swagger2markup` 将其换为 Markdown 格式。 ```groovy // build.gradle dependencies { implementation 'io.springfox:springfox-swagger2:2.6.1' implementation 'io.springfox:springfox-swagger-ui:2.6.1' } ``` ```bash # 使用 swagger2markup 将 Swagger JSON 换为 Markdown swagger2markup convert -i swagger.json -f api-documentation.md ``` 通过以上方法,你可以轻松地将 Swagger API 文档导出为 Markdown 格式,方便离线阅读和分享[^2]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值