本文目录
什么是 JSON 转 TypeScript 转换？
JSON 转 TypeScript 转换，是分析一个 JSON 数据结构，并生成描述该数据形态的相应 TypeScript 类型定义——接口（interface）或类型别名（type alias）——的过程。这让开发者免于为 API 响应、配置文件和其他 JSON 数据源手写类型定义。
TypeScript 的类型系统能在编译期捕获那些原本会以运行时缺陷形式出现的错误。通过从真实的 JSON 数据生成类型，你可以确保类型定义准确反映实际的数据结构，而不必依赖文档或凭空假设。
转换器的工作原理
我们的转换器会递归分析 JSON 结构，并生成整洁的 TypeScript 定义。
- 结构分析——递归遍历 JSON 树，为基本类型（string、number、boolean、null）推断类型，并检测嵌套对象和数组
- 数组处理——分析数组元素以判断它们是否共享同一类型，当元素类型不同时生成联合类型
- 输出选项——可在 interface 和 type alias 语法之间选择、切换 export 关键字、添加 readonly 修饰符，以及自定义根类型名称
免费试用 —— 无需注册
将 JSON 转换为 TypeScript →何时使用 JSON 转 TypeScript 转换
只要你在 TypeScript 项目中处理外部数据，从 JSON 生成类型就很有用。
- API 集成——粘贴一段示例 API 响应，即可为前端服务层立即获得类型定义
- 配置文件——为 JSON 配置文件生成类型，从而在 IDE 中获得自动补全和校验
- 数据库架构——将来自 MongoDB 或其他基于 JSON 的数据库的示例文档转换为 TypeScript 类型，用于数据访问层
常见问题
我应该使用 interface 还是 type alias？
两者在大多数场景下都适用。接口通常更适合描述对象形态，因为它们支持声明合并，并且在错误信息中更易读。类型别名更灵活，可以表示联合类型、交叉类型和映射类型。转换器允许你根据项目约定选择任意一种格式。
转换器如何处理 null 值？
当转换器在 JSON 中遇到 null 值时，它会生成联合类型：例如 `name: string | null`。如果某个字段在样本数据中始终为 null，它会被标注为 `null` 类型。为获得最准确的类型，请提供为所有字段都包含非 null 值的示例 JSON。
我可以转换嵌套的 JSON 结构吗？
可以。转换器会递归处理嵌套对象，并为每个嵌套结构生成独立的具名接口。例如，一个带有 address 字段的 user 对象会同时生成一个根接口和一个 Address 子接口，使生成的代码保持整洁且可复用。