Trae怎么做那种根据API响应的JSON结构自动生成对应的TypeScript类型定义?

老敏酱_4221

老敏酱_4221

2026-05-23

792人浏览

原创

可自动生成typescript类型定义的五种方法:一、json2ts在线工具;二、quicktype cli;三、vs code插件json to ts;四、tsc-json-schema配合json schema;五、deno与json-schema-to-typescript库。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

trae怎么做那种根据api响应的json结构自动生成对应的typescript类型定义?

如果您需要根据 API 响应的 JSON 结构自动生成对应的 TypeScript 类型定义,则可能是由于手动编写接口类型耗时易错、难以同步后端变更。以下是实现该目标的多种方法:

一、使用 json2ts 在线工具

该方法适用于快速验证或一次性生成,无需安装依赖,直接粘贴 JSON 即可获得类型定义。

1、访问 https://json2ts.com/ 网站。

2、在左侧文本框中粘贴有效的 JSON 响应示例(如 { "id": 1, "name": "Alice", "active": true })。

3、点击 “Convert” 按钮,右侧将自动生成对应 TypeScript 接口代码。

4、复制生成的 interface 或 type 声明,粘贴至项目中的 .ts 文件中。

二、使用 quicktype CLI 工具

该方法支持本地批量处理、多语言输出,并可保留字段注释与嵌套结构,适合集成进开发流程。

1、在终端中执行 npm install -g quicktype 安装命令行工具。

2、将 JSON 响应保存为 sample.json 文件,确保内容为合法 JSON 格式(不含 trailing comma 或单引号)。

3、运行命令 quicktype -l typescript -o ApiTypes.ts sample.json。

4、检查生成的 ApiTypes.ts 文件,确认接口名是否符合命名规范(如默认为 TopLevel),必要时通过 --src-lang json --top-level MyResponse 参数指定。

三、使用 VS Code 插件 JSON to TS

该方法适合在编辑器内即时生成,避免切换窗口,支持从剪贴板或当前打开的 JSON 文件提取结构。

1、在 VS Code 扩展市场中搜索并安装 JSON to TS 插件。

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载

2、新建一个 .json 文件,粘贴响应体内容,或直接在已打开的 JSON 响应片段上右键。

3、选择 “JSON to TS” 命令,插件将自动推断类型并生成 interface 块。

4、生成结果默认插入新编辑器标签页,可直接修改 interface 名称并保存为 .d.ts 或 .ts 文件。

四、使用 tsc-json-schema 配合 JSON Schema

该方法适用于已有 OpenAPI/Swagger 文档或可导出 JSON Schema 的场景,生成结果更贴近真实 API 约束。

1、从 API 文档平台导出 JSON Schema 文件(如 schema.json),确保包含 $ref、required、type 等字段。

2、执行 npx ts-json-schema-generator --path schema.json --tsOutputPath schema.d.ts。

3、若需映射到特定接口名,添加参数 --type MyApiResponse。

4、生成的 schema.d.ts 中将包含基于 JSON Schema 规则的精确类型,例如 string 格式限制、最小长度等会被转为 type 声明。

五、使用 deno 与 json-schema-to-typescript 库

该方法适合 Deno 项目或需要高度定制化输出格式(如添加 JSDoc 注释、忽略某些字段)的场景。

1、创建脚本文件 generate_types.ts,导入 https://deno.land/x/json_schema_to_typescript@v7.0.0/mod.ts。

2、读取本地 JSON 响应字符串,调用 compile() 方法并传入配置对象,设置 unreachableDefinitions: true。

3、将返回的 TypeScript 字符串写入 output.ts 文件,使用 Deno.writeTextFile()。

4、运行 deno run --allow-read --allow-write generate_types.ts 执行转换。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json typescript trae

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3049

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1158

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3360

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15075

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.9万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习