JSON 转类型定义

高级选项
json
不换行
typescript
不换行
                    export type Root = {
    name: string;
    age: number;
    isStudent: boolean;
    address: {
        street: string;
        city: string;
        state: string;
        zip: number;
    };
};

                
概述
Generated by AI

JSON 类型生成器是一个自动化工具,能够将 JSON 数据转换为多种编程语言的类型定义。无需手动编写类型声明,只需粘贴 JSON 数据即可快速生成准确的类型定义代码。

主要功能

多语言支持

工具支持生成多种主流编程语言的类型定义:

  • TypeScript: 生成接口或类型别名定义
  • Rust: 生成结构体和枚举类型
  • Kotlin: 支持 Jackson 和 kotlinx.serialization 两种序列化框架
  • Python: 生成 Pydantic 模型定义
  • JSON Schema: 生成标准 JSON Schema 格式

智能类型推断

工具会自动分析 JSON 数据结构,识别数据类型并生成准确的类型定义。对于嵌套对象和数组,会递归生成所有必要的类型声明。

命名规范转换

可自定义属性名的命名格式,支持多种常见命名规范:

  • camelCase: 驼峰命名法
  • PascalCase: 帕斯卡命名法
  • snake_case: 蛇形命名法
  • kebab-case: 短横线命名法
  • 以及其他大写变体

导入样式管理

针对生成的类型定义,可选择不同的导入处理方式:

  • 假设现有导入:不添加额外导入语句
  • 添加所需导入:自动添加必要的导入声明
  • 使用完全限定路径:使用完整的模块路径

使用场景

API 响应类型定义

在前端开发中,将后端 API 返回的 JSON 数据快速转换为 TypeScript 类型定义,提高代码类型安全性。

{
  "user": {
    "id": 12345,
    "name": "张三",
    "email": "zhangsan@example.com",
    "roles": ["admin", "user"]
  }
}

通过工具可立即生成对应的 TypeScript 类型定义:

interface Root {
  user: User;
}

interface User {
  id: number;
  name: string;
  email: string;
  roles: string[];
}

数据模型快速搭建

在项目初期或重构时,根据现有的 JSON 数据样本快速生成数据模型的类型定义,加速开发流程。

跨语言类型迁移

在不同编程语言之间迁移项目时,可以使用此工具快速转换数据类型定义,减少人工转换的工作量和错误率。

高级选项

展开路径

使用 JSON 指针语法指定需要展开的嵌套路径,工具会将指定路径下的数据提升到顶层类型定义中。支持使用 - 作为数组通配符。

收集未知属性

启用后,生成的类型定义会允许额外的未声明属性,适用于数据结构可能扩展的场景。

自定义类型名称

可为生成的根类型指定自定义名称,便于在代码中引用和理解。

注意事项

使用工具生成的类型定义应根据实际业务需求进行审查和调整。对于复杂或特殊的数据结构,可能需要手动优化生成的代码。

展开更多