JSON 自动生成接口类型定义:联调不再对字段
前后端联调时,最常出现的 bug 是「字段名拼错」「类型对不上」。如果后端能甩给你一段示例 JSON,你马上就能生成类型,把这些低级错误挡在编译期。
典型工作流
- 后端在接口文档里附一段示例 JSON(或你从响应里复制)。
- 粘贴到 工具 生成 TS interface。
- 落到代码里,请求函数直接复用该类型。
示例产物:
export interface Root {
id: number;
name: string;
active: boolean;
tags: string[];
profile: {
city: string;
followers: number;
};
scores: number[];
}
和 OpenAPI 的关系
OpenAPI 适合整站接口规范;而本工具适合「就这一段 JSON 快速要个类型」的轻量场景,几秒钟搞定,不引入额外流程。
常见问题
数组里混了对象和基础类型怎么办?
工具会合并出现的类型,保证生成的类型能容纳真实数据,不会漏掉分支。
能直接生成 axios 的泛型吗?
生成的 interface 可直接作为 axios.get<Root>() 的泛型参数。
相关阅读