可自动生成typescript类型定义的五种方法:一、json2ts在线工具;二、quicktype cli;三、vs code插件json to ts;四、tsc-json-schema配合json schema;五、deno与json-schema-to-typescript库。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您需要根据 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 插件。
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应用能力赋能!











