JSON转TypeScript
工具介绍
前端要对齐后端字段时,从一份真实 JSON 生成类型,比对着 Network 面板手抄更快。可选 interface 或 type,字段可以全部标成可选。这是一份快照,不是 OpenAPI,枚举和注释仍要你补。
功能特点
- 生成 interface 或 type 别名
- 嵌套对象拆成多层类型
- 可把字段一律标成可选
如何使用
- 粘贴一份真实响应,最好覆盖空值和缺字段。
- 选择 interface 或 type,填写根类型名。
- 原型阶段字段可能缺失时,打开可选字段。
- 复制后把 any、过宽的 number 和联合类型收窄。
使用场景
- 前端要对齐一份刚联调出来的响应
- 项目还没有 OpenAPI,先用样例顶上类型
- 字段经常缺省,先全部标成可选再逐步收紧
示例说明
- {"id":1,"name":"Ada"} 会生成 id: number 与 name: string。
- 打开可选后,字段写成 id?: number,避免缺字段报错。
常见问题
能生成联合类型吗?
按当前样例推断。同一字段有时是对象有时是 null 时,生成后请自行收窄联合。
和 OpenAPI 生成有何不同?
这里只有一份 JSON 快照,没有文档里的枚举、必填和注释。有 spec 时仍应用 OpenAPI 工具。
interface 和 type 怎么选?
对象形状用 interface 更常见;需要联合或交叉时用 type。可以先生成再按项目规范改。
可选字段适合什么时候开?
响应经常缺键、或还在改接口时。稳定契约后应对照文档改回必填。
JSON 会上传吗?
不会。类型生成在浏览器本地完成。
和 JSON 转 Go 有什么区别?
本页产出 TypeScript。服务端模型请用 JSON 转 Go。两边都可以从格式化后的同一份数据出发。
返回 JSON工具大全
相关教程