JSON 整理与类型生成可运行案例
用户列表:从接口样本生成 TypeScript 类型草稿
根据 用户列表 的两条样本推断嵌套对象和数组类型。生成声明不会在运行时校验接口响应;可选字段、枚举和完整业务合同仍需人工确认。编号保持字符串。
试一试
在完整工具中打开 ↗示例工作台
JSON 整理与类型生成修改下方数据后重新运行
运行结果
// 根据样本推断;必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
"ok": boolean;
"data": {
"users": ({
"userId": string;
"displayName": string;
"loginCount": number;
"active": boolean;
"role": string;
"profile": {
"city": string;
"tags": (string)[];
};
})[];
"summary": {
"total": number;
"note": null;
};
};
};
原例已核验,可修改输入后重新运行。
⌘ / Ctrl + Enter 运行01
场景与操作说明
用户列表通常同时包含标识、展示名称、状态和资料。联调时先区分展示字段与权限字段,不能用昵称替代用户标识。
loginCount 是示例累计登录次数;0 是有效值,不应当成字段缺失。
- 核对 用户列表 的字段层级,保留 userId 的字符串类型。
- 修改一项输入并运行,观察结果中的值或路径如何变化。
- 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02
对照样本
对照样本的 users 为空数组,没有提供元素类型证据。生成结果不能据此证明真实接口永远返回空数组。
查看对照输入
{
"ok": true,
"data": {
"users": [],
"summary": {
"total": 2,
"note": null
}
}
}对照样本的实际结果
// 根据样本推断;必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
"ok": boolean;
"data": {
"users": (unknown)[];
"summary": {
"total": number;
"note": null;
};
};
};