JSON 转 TypeScript
将 JSON 示例转换为 TypeScript 接口或类型别名。嵌套对象会成为独立的命名类型;对象数组会合并,因此只在部分项中出现的键会变为可选属性;混合值会成为联合类型。粘贴 API 响应,选择 interface 或 type,然后复制可直接放入代码中的声明。
常见问题
如何处理嵌套对象?
每个嵌套对象都会生成自己的声明,名称取自包含它的键,并转换为 PascalCase,例如 address 会变成 Address。数组中的对象按数组键的单数形式命名,因此 users 会变成 User,categories 会变成 Category。字段完全相同的对象会共用同一份声明。
属性何时会变为可选?
当数组包含多个对象,且某个键在其中一些对象中缺失时,该键会加上问号标记为可选。每一项中都出现的键仍为必填。单个对象没有其他样本可供比较,因此其中所有键都是必填的。
如何为 null 值指定类型?
如果示例中的某个键为 null,其类型会设为 null;如果该键在部分项中为 null、在其他项中为字符串,则类型会变为 string | null。如果真实数据中的某个字段可能为 null,但示例中从未出现 null,请手动添加 null,或粘贴包含 null 的示例。
我应该选择 interface 还是 type?
两者都能描述相同的结构。接口可以扩展和合并,许多风格指南更倾向用它来描述对象结构;类型别名也适用于联合类型,有些团队则在所有地方都使用它。选择代码库当前使用的方式,字段完全相同。
如何指定数组的类型?
只包含一种值的数组会变成该类型后加 [],例如 string[] 或 User[]。包含多种类型的数组会变成括号括起的联合类型,例如 (string | number)[]。空数组会变成 unknown[],因为示例没有提供数组项的信息。
不符合有效标识符规则的键会怎样处理?
包含空格、连字符或其他不允许出现在 TypeScript 标识符中的字符的键会加上引号,例如 "first-name": string。这种写法符合 TypeScript 规范,并且与 JSON 完全一致。
数字会指定为整数还是浮点数?
TypeScript 只有一种数字类型,因此整数和小数都会变成 number。如果你需要区分哪些值是整数,JSON Schema Generator 可以区分 integer 和 number。
可以重命名根类型吗?
可以。为根类型输入一个名称,例如 ApiResponse。名称会转换为 PascalCase,嵌套类型则保留根据其键生成的名称。如果 JSON 的顶层是数组或单个值,根类型会成为该值的类型别名。
会检测日期吗?
不会。JSON 没有日期类型,因此示例中的日期会被视为字符串,类型也会设为 string。解析后,可在代码中将其转换为 Date;如果使用模板字面量类型,也可以手动缩小类型范围。
JSON 的大小上限是多少?
最多 1,000,000 个字符,嵌套深度最多为 64 层。示例只会用于生成类型,不会被存储。