API SPEC IN. MARKDOWN OUT.

OpenAPI / Swagger → Markdown.

把 JSON / YAML 接口规范,整理成便于阅读、分享和交给 AI 的 Markdown。

免费 · 无需登录本地处理 · 支持本地 $ref
API 文档工作台
支持 JSON / YAML · 停止输入 300ms 自动生成
等待识别格式与版本1,271 字符
可编辑 · 重新生成会覆盖编辑0 字符
这是简化文档转换器,不是完整 OpenAPI 渲染器。支持本地 $ref;allOf 合并字段,oneOf / anyOf 仅列选项;callbacks / webhooks 不展开。

全部在浏览器本地处理,不上传、不保存,不请求外部引用地址。刷新页面后内容清空。

从接口规范到文档,只需三步

STAY IN THE BROWSER
01

粘贴 JSON 或 YAML

放入 OpenAPI 3.x 或 Swagger 2.0 文档,也可以先载入示例了解格式。

02

生成结构化 Markdown

停止输入 300 毫秒后自动生成,或点击「生成 Markdown」。接口按 tag 分组,本地引用自动解析。

03

检查、编辑、带走

核对简化后的参数和字段摘要,直接修改输出,再复制或下载 .md 文件。

A FEW THINGS TO KNOW

你可能想知道

关于格式、引用、隐私和简化展示的边界。

OpenAPI / Swagger 转 Markdown 免费吗?

免费,无需登录。粘贴文档即可生成可编辑的 Markdown,支持一键复制和下载 .md 文件。

支持哪些版本和输入格式?

支持带 openapi 3.x 或 swagger 2.0 版本字段的 JSON、YAML 文档,工具自动识别格式。解析错误会提示中文原因,语法错误尽量定位到行和列。

我的 API 文档会被上传或保存吗?

不会。解析、生成、复制与下载全部在浏览器本地完成,不上传、不保存内容,也不会请求外部引用地址;刷新页面后内容清空。

本地 $ref 引用可以展开吗?

可以。支持 #/components/schemas、#/definitions 等本地 JSON Pointer,也支持请求体、参数和响应引用。找不到或非本地的引用保留原文并注明未解析,循环引用和过深结构会停止展开。

生成结果包含哪些内容?

包含标题、版本、服务器地址、按第一个 tag 分组的接口、参数表、请求体字段摘要和响应表。可以直接编辑结果,再复制到 README、笔记或 AI 对话;重新生成会覆盖手动编辑。

这是完整的 OpenAPI 渲染器吗?

不是。本工具侧重生成便于阅读的简化文档:allOf 合并 properties,oneOf / anyOf 仅列出选项,callbacks / webhooks 不展开,不替代规范校验器。请求体仅选择一种媒体类型,优先 application/json;复杂约束和嵌套字段仍需对照原规范。

文档理清了,让 AI 帮你接好 API?

探索 AIGoCode,让 AI 更顺手地融入你的开发工作流。

探索 AIGoCode ↗