Swagger转Markdown
将 OpenAPI 2.0/3.0 规范转换为结构清晰的 Markdown 文档,支持 $ref 引用展开、按 Tag 分组
支持拖拽 .json / .yaml / .yml 文件
关于 Swagger 转 Markdown
- 将 OpenAPI 2.0(Swagger)/ 3.0 规范 JSON 转换为结构清晰的 Markdown 接口文档
- 自动按 Tag 分组、展开
$ref引用、解析allOf/oneOf组合类型 - 生成的 Markdown 包含完整的请求参数表、请求体字段表、响应状态码及响应字段表
- 转换结果可直接粘贴到 Confluence、Notion、GitHub Wiki、飞书文档等平台
操作说明
- 粘贴 OpenAPI JSON 规范到左侧输入框,点击「转换」生成 Markdown
- 支持拖拽
.json文件上传 - 点击「复制」或「下载 .md」保存转换结果
- 支持快捷键 Ctrl+Enter 执行转换
注意事项
- 当前版本支持 JSON 格式输入,YAML 格式请先通过 JSON/YAML 互转工具转为 JSON
$ref引用会自动递归展开(最大深度 4 层,防止循环引用)- 复杂的
discriminator、callbacks等高级特性暂不支持,需手动补充 - 所有处理均在浏览器本地完成,不会上传任何数据
OpenAPI 规范知识详解
OpenAPI 2.0 vs 3.0 对比
| 特性 | OpenAPI 2.0 (Swagger) | OpenAPI 3.0 |
|---|---|---|
| 版本标识 | swagger: "2.0" | openapi: "3.0.x" |
| 服务器定义 | host + basePath | servers 数组 |
| 请求体 | 参数中 in: body | 独立 requestBody |
| Schema 定义 | definitions | components/schemas |
| 组合类型 | 仅 allOf | allOf / oneOf / anyOf |
$ref 引用机制
OpenAPI 使用 JSON Reference 实现 Schema 复用,避免重复定义:
"schema": { "$ref": "#/components/schemas/User" }
本工具会递归展开引用,将引用的 Schema 属性内联到参数表和响应表中,最大递归深度 4 层以防止循环引用。
组合类型(allOf / oneOf / anyOf)
| 关键字 | 语义 | 典型场景 |
|---|---|---|
allOf | 同时满足所有子 Schema | 继承/混入(Mixin),如 BaseModel + 扩展字段 |
oneOf | 恰好满足其中一个 | 多态类型,如 CatOrDog |
anyOf | 满足一个或多个 | 灵活的联合类型 |
常见 Schema 类型与格式
| type | format | 说明 |
|---|---|---|
| integer | int32 / int64 | 32 位 / 64 位整数 |
| number | float / double | 浮点数 |
| string | date / date-time / email / uri / uuid | 带格式约束的字符串 |
| string | binary / byte | 二进制数据 / Base64 编码 |
| boolean | — | 布尔值 |
| array | — | 数组,通过 items 定义元素类型 |
| object | — | 对象,通过 properties 定义字段 |