example to doc

API 文档生成一段响应 JSON,直接变成字段说明表

写接口文档最枯燥的是照着响应抄字段名和类型。这里粘贴一段 JSON,工具递归解析出字段路径、类型、示例值,生成 Markdown 表格与响应示例,可直接贴进 Wiki 或仓库 README。与 OpenAPI 查看器不同,本工具从示例反推文档。

JSON 反推嵌套字段路径类型推断Markdown示例保留
① 粘贴响应示例
生成的文档会显示在这里。

「必填」依据示例是否出现推断,不能替代真实接口约束,请人工确认。

📑口径说明与常见误填

必填只能靠示例推断,正式文档请对照接口定义。

字段路径怎么读
data.user.id 表示响应里 data 对象的 user 对象的 id 字段;data.list[] 表示数组元素的结构。
类型怎么推断
按示例值判断 string / number / boolean / null / object / array;数组中第一个对象会被递归展开。
必填为什么写「示例中出现」
单份 JSON 无法判断字段是否必填。字段存在只能说明这次返回了它,不能说明它永远都有。
和 OpenAPI 查看器的区别
OpenAPI 查看器读已有规范;本工具从真实响应样例反推,适合接口还没有写文档时快速起步。

这个工具解决什么问题

API 文档生成把「照着响应抄字段」自动化:粘贴一段 JSON,工具递归解析出字段路径、类型、示例值,生成 Markdown 字段表与响应示例,可导出为 .md 直接提交到仓库。它适合接口联调初期快速产出初稿;必填性无法从单份样例确定,页面会如实标成「示例中出现」,最终仍需对照接口定义人工确认。

写接口文档的三条经验

① 用真实响应:拿一条字段最全的样例,生成的表格更完整。

② 必填要人工补:示例推断不出约束,发布前对照代码确认。

③ 数组展开一层:工具会递归第一个数组元素,复杂数组建议另写说明。

怎么用

  1. 第 1 步 · 粘贴 JSON
    用实际接口返回的完整样例。
  2. 第 2 步 · 填接口信息
    名称、方法、路径。
  3. 第 3 步 · 生成文档
    查看字段表与示例。
  4. 第 4 步 · 导出 Markdown
    贴进 Wiki 或仓库。

更新记录

  • v1.0 2026-11-16
  • 首个版本:JSON 递归解析、字段路径、类型推断、Markdown 表格与响应示例、导出

常见问题

支持数组响应吗?
支持,顶层数组会取第一个对象展开,路径写作 data[]。
必填字段准吗?
不准,只是示例里出现了。正式文档请以接口定义为准。
能生成 OpenAPI 吗?
不能,生成的是 Markdown 字段表与示例,不是 OpenAPI 规范。
嵌套对象能展开几层?
理论上递归展开到叶子节点,太深的层级表格会很长。
中文注释能加吗?
页面可看可复制,导出后再在 Markdown 里补说明列。
数据会上传吗?
不会,解析全部在浏览器本地。

💬 留言板 0

全部留言需审核通过后展示
💬

还没有留言,来抢沙发吧!

✍️ 说点什么
0 / 500
图形验证码
👣 做完这一步,顺便看看
🧰 乱码修复 / 文本编码转换 在线乱码修复工具:上传乱码文本文件或粘贴乱码字符串,用 UT… → 💻 假装工作模拟器 老板走近工位的一瞬间,点一下就能从摸鱼切回正经工作界面。代码… → 🧰 IP / 子网掩码计算器 在线子网计算器:输入 IP 地址与掩码(CIDR 前缀或点分… → ⏰ 下班倒计时 打工人专属下班计算器:实时倒计时距离下班还有多久、进度环显示… →
全部工具 →