工具
JSON 样本转 TypeScript 与 JSON Schema
根据 JSON 样本推断 TypeScript interface、type 与 JSON Schema,检查可选字段、联合类型、null 与空数组,手动调整字段后本地复制或下载一致的结构定义。
1. JSON 样本
输入只留在当前标签页:本地 Worker 推断结构,不上传、不抓取 URL、不保存、不调用 API。
结果根据样本推断,不代表完整接口契约。请补充不同情况的真实样本,检查缺失字段、null 和空数组,再与接口维护者确认。
2. 推断结果
原始值和数组根在 interface 模式仍使用 type 别名,对象结构使用命名 interface。Schema 默认允许额外字段。
推断说明
调整字段类型和可选性
路径使用 JSON Pointer 转义,/* 表示数组元素。类型调整会替换整个字段,包括嵌套对象;选择「按样本推断」恢复原结构。每次调整后重新合并相同结构。父字段被覆盖时,其子字段调整不生效。
| 路径 | 推断 / 当前类型 | 调整类型 | 可选 |
|---|
边界与解读
部分对象样本中缺失的字段为可选字段,显式 null 保留为 null 或联合类型。空数组在有非空数组样本补充前推断为 unknown[]。混合值形成联合类型,相同对象结构复用名称。字段按首次出现排序,使用两空格缩进。数字仅推断 number,不猜枚举或日期格式。
上限为 500,000 字符、20,000 个 JSON 值、500 个推断字段、64 层嵌套。重复键和超出安全整数范围的数字会给出源位置并拒绝,避免静默丢失样本信息。不生成完整 OpenAPI、不抓取 URL、不验证后端响应,也不能从单个样本得知未来字段。
常见问题
生成结果等于完整接口契约吗?
不等于。定义仅根据提供的样本推断,无法知道未来字段、未出现的类型分支或业务规则。请补充不同情况的样本,重点检查 null、空数组和可选字段。
如何合并多份接口响应样本?
选择对象样本数组模式,将多个对象合并为一个定义,部分样本缺失的字段标为可选。单个 JSON 值模式则保持真实数组根值,不擅自拆成对象样本。
手动调整会同步全部输出吗?
会。TypeScript interface、type 与 JSON Schema 共用同一个模型。字段类型覆盖替换整个字段,可选性同时影响 TypeScript 问号和 Schema required 清单。
会上传输入或抓取接口 URL 吗?
不会。JSON 只在当前标签页的本地 Worker 内处理,不上传、不抓取 URL、不持久保存,也不验证后端实时响应。Schema 允许额外字段,unknown[] 与显式 null 保持可见,不猜测未知内容。