JSON 转 TypeScript:自动生成类型

JSON 转 TypeScript:自动生成类型

手写接口返回的 TypeScript 类型,就像重打一份打印好的文档。JSON 本身就是规范——类型应该由工具生成。

本站的 JSON 转 TypeScript 工具在浏览器里把 JSON 样例转成接口。

它产出什么

粘入:

{ "user": { "name": "Ada", "age": 36 } }

得到 TypeScript 接口:

interface Root {
  user: {
    name: string;
    age: number;
  };
}

类型从值推断:字符串变 string、数字变 number、布尔变 boolean、数组变元素类型的数组。

为什么生成胜过手写

  • 快:50 个字段的返回一秒生成,而不是半小时打字。
  • 准:不漏字段、不错类型——样例精确地定义它们。
  • 一致:字段名和接口逐字节对齐。

注意事项

  • 类型取决于样例:如果接口有时对 age 返回 null,用 36 做样例生成的类型就是 number——运行时会崩。接口不一致时,联合类型(number | null)是你的活。
  • 空数组:[] 让转换器无从推断。喂一个有数据的样例,或手工放宽类型。
  • 可选字段:转换器默认所有字段必填,除非有选项说明。真实接口里把字段标记为可选很重要。

工作流

  1. 从接口复制一个有代表性的返回(带真实数据的;压缩过的先用 JSON 格式化工具读一下)。
  2. 粘进 JSON 转 TypeScript 工具生成接口。
  3. 粘进代码库,再按现实调整联合类型和可选标记。

生成的类型是 95% 正确的起点。手写类型花 100% 的力气,还是会漏字段。拿那个 95%。