JSON 转 TypeScript
根据 JSON 数据自动生成 TypeScript 类型定义,支持多种输出风格与代码选项。
生成设置
代码选项
使用说明
为什么需要 JSON 转 TypeScript?
- 从 API 响应自动生成类型定义,减少手动编写的工作量
- 确保前端代码与后端数据结构保持一致
- 利用 TypeScript 的类型检查在编译时发现潜在问题
- 提供更好的 IDE 自动补全和文档提示
输出风格说明
- Interface:使用
interface关键字定义类型,支持声明合并和扩展 - Type Alias:使用
type关键字定义类型别名,更灵活,支持联合类型和交叉类型
代码选项说明
- 添加 export:为每个类型声明添加
export关键字,便于作为模块导出 - readonly 成员:将接口属性标记为
readonly,强制不可变性 - 联合类型替代 enum:枚举字段使用
type X = "a" | "b"而非enum
配置选项
可自定义根类型名称、输出风格(interface/type)、是否添加 export 关键字、是否使用 readonly 成员、是否以联合类型替代 enum。基于 quicktype 引擎,嵌套对象会自动生成对应的子类型,数组会推断元素类型并生成联合类型,可选字段由引擎自动推断。