Swagger转Markdown
将 OpenAPI 2.0/3.0 规范转换为结构清晰的 Markdown 文档
支持拖拽 .json / .yaml / .yml 文件
使用场景
- OpenAPI 规范文件机器可读性强,但直接阅读体验差,转为 Markdown 后可读性大幅提升
- 转换结果可直接粘贴到 Confluence、Notion、GitHub Wiki、飞书文档等平台
- 适合团队内部文档沉淀、接口评审和 API 变更记录
- 转换内容包含:接口路径、HTTP 方法、请求参数表格、响应状态码说明
操作说明
- 粘贴 OpenAPI JSON 规范到左侧,点击「转换」生成 Markdown
- 支持拖拽
.json/.yaml文件上传 - 点击「复制结果」或「下载 .md」保存转换结果
- 快捷键:Ctrl + Enter 执行转换
注意事项
- 当前版本仅支持 JSON 格式输入,YAML 请先通过其他工具转为 JSON
- 规范中的
$ref引用不会自动展开,仅显示引用路径 - 生成的 Markdown 为标准格式,可根据平台需要手动调整标题层级