input.json
types.ts
点击转换生成 TypeScript 接口。

相关

与 TS Types 相关的指南

全部指南 →

JSON 转 TypeScript 的工作方式

每个 JSON 对象都会生成一个 TypeScript interface。根对象默认命名为 Root。嵌套对象会按对应的属性键生成各自的命名接口 —— 名为 address 的键会得到一个 Address 接口。

数组与可选字段

对象数组会合并所有元素中出现过的键。如果某些项缺失了某个键,它会变成可选属性(key?: Type)。基本类型数组会得到带类型的签名,例如 string[]number[]

什么时候用它

  • API 接入 —— 贴上响应体,立刻得到可以放进 TypeScript 项目的类型定义
  • 原型阶段 —— 在着手解析逻辑之前,先快速搭起对新 API 或数据集的接口骨架
  • 代码评审 —— 确认 JSON 负载的形状与代码期望的接口一致