JSON转Typescript类

工具简介

“JSON转Typescript类”是一款高效便捷的在线工具，旨在帮助开发者快速将复杂的JSON字符串转换为结构清晰、类型安全的TypeScript类或接口定义。它通过解析您提供的JSON数据，智能推断字段类型，并自动生成符合TypeScript语法规范的代码，极大地简化了前端数据模型的创建过程，提升开发效率和代码质量，尤其适用于前端与后端API接口的数据模型对接。

如何使用

1. 在左侧的“JSON字符串”输入框中，粘贴或手动输入您需要转换的JSON数据。请确保输入的JSON字符串语法正确，是有效的JSON格式。
2. 工具会自动或在您点击转换按钮（如果有的话）后进行处理，您无需执行额外操作。
3. 在右侧的“转换后的类”输出框中，您将立即看到根据JSON结构生成的TypeScript类或接口代码。您可以直接复制这些代码到您的项目中，用于定义数据模型。

输入参数格式： 必须是符合JSON标准语法的字符串，例如JSON对象 {} 或JSON数组 []。

输出结果格式： 符合TypeScript语法的类（class）或接口（interface）定义代码，包含属性名称及其推断出的TypeScript类型。

使用示例

以下是一个将典型JSON对象转换为TypeScript接口的示例：

示例输入数据：

{
  "productId": "P001",
  "productName": "智能手机",
  "price": 1999.00,
  "isOnSale": true,
  "features": ["5G", "高清屏幕", "长续航"],
  "manufacturer": {
    "name": "科技巨头",
    "country": "中国"
  }
}

预期输出结果：

转换后的TypeScript代码可能如下（具体生成的类或接口名称和结构可能因工具内部逻辑略有差异，通常会生成接口）：

interface Product {
  productId: string;
  productName: string;
  price: number;
  isOnSale: boolean;
  features: string[];
  manufacturer: Manufacturer;
}

interface Manufacturer {
  name: string;
  country: string;
}

具体操作演示：

1. 复制上述“示例输入数据”中的JSON字符串。
2. 访问本“JSON转Typescript类”在线工具页面。
3. 将复制的JSON字符串粘贴到左侧“JSON字符串”输入框。
4. 观察右侧“转换后的类”输出框，即可看到根据JSON结构自动生成的TypeScript接口代码，包括嵌套对象的类型定义。

常见问题

• 问：支持哪些输入格式？
• 答：本工具严格支持标准格式的JSON字符串作为输入。这包括JSON对象 {} 和JSON数组 []。请确保您的输入数据是有效的JSON格式。
• 问：输出结果是什么格式？
• 答：输出结果是符合TypeScript语法的类（class）或接口（interface）定义代码。工具会根据JSON的嵌套结构，生成一个或多个相互关联的TypeScript类型定义。
• 问：如何处理JSON中的可选字段？
• 答：大部分JSON转TypeScript工具默认会将JSON中的所有字段都推断为必填属性。如果您需要某个字段是可选的，例如在API响应中可能不存在的字段，您可以在生成代码后手动在属性名后添加 ? 符号，如 fieldName?: type;。
• 问：是否支持数组内的复杂对象转换？
• 答：是的，如果JSON中包含对象数组（例如 "items": [{ "id": 1, "name": "Item A" }]），工具会自动为数组中的每个对象结构生成对应的TypeScript类型定义。
• 问：转换结果可以自定义生成类还是接口吗？
• 答：当前工具默认生成TypeScript接口（interface），因为它在数据模型定义中更为常用和轻量。如果未来有生成类的需求，可能会提供相关配置选项。

注意事项

• 输入数据格式校验： 请务必提供格式正确、符合JSON语法规范的字符串。任何JSON语法错误（如缺少引号、逗号、括号或结构不匹配）都将导致转换失败或生成不正确的TypeScript代码。建议在转换前使用专业的JSON校验工具验证您的JSON数据。
• 类型推断局限性： 本工具会尽力根据JSON值推断最合适的TypeScript类型（如 number, string, boolean, array, object 等）。然而，对于某些特殊情况，例如空数组 [] 或值不明确的字段，工具可能无法准确推断其内部元素的类型，此时可能会默认生成 any[] 或需要您手动指定更精确的类型。
• 根类型命名： 工具通常会为最外层的JSON结构生成一个默认的类型名称（例如 Root, Data 或根据输入名称推断）。您可以根据项目的实际需求和命名规范，手动修改生成的类型名称。
• 复杂嵌套结构： 对于层级较深、结构复杂的JSON数据，工具会生成多个相互关联的TypeScript接口或类，以准确反映其数据模型。请注意代码的可读性和维护性。
• TypeScript版本兼容性： 生成的代码遵循标准的TypeScript语法。通常兼容主流的TypeScript版本，但在极少数情况下，特定配置或较旧的TypeScript环境可能需要微调。