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 层,防止循环引用)
  • 复杂的 discriminatorcallbacks 等高级特性暂不支持,需手动补充
  • 所有处理均在浏览器本地完成,不会上传任何数据
OpenAPI 规范知识详解
OpenAPI 2.0 vs 3.0 对比
特性OpenAPI 2.0 (Swagger)OpenAPI 3.0
版本标识swagger: "2.0"openapi: "3.0.x"
服务器定义host + basePathservers 数组
请求体参数中 in: body独立 requestBody
Schema 定义definitionscomponents/schemas
组合类型allOfallOf / 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 类型与格式
typeformat说明
integerint32 / int6432 位 / 64 位整数
numberfloat / double浮点数
stringdate / date-time / email / uri / uuid带格式约束的字符串
stringbinary / byte二进制数据 / Base64 编码
boolean布尔值
array数组,通过 items 定义元素类型
object对象,通过 properties 定义字段
@section scripts { }