JSON 整理与类型生成可运行案例
多语言词条:从接口样本生成 TypeScript 类型草稿
根据 多语言词条 的两条样本推断嵌套对象和数组类型。生成声明不会在运行时校验接口响应;可选字段、枚举和完整业务合同仍需人工确认。编号保持字符串。
试一试
在完整工具中打开 ↗示例工作台
JSON 整理与类型生成修改下方数据后重新运行
运行结果
// 根据样本推断;必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
"ok": boolean;
"data": {
"messages": ({
"messageKey": string;
"sourceText": string;
"revision": number;
"reviewed": boolean;
"namespace": string;
"translations": {
"en": string;
"locales": (string)[];
};
})[];
"summary": {
"total": number;
"note": null;
};
};
};
原例已核验,可修改输入后重新运行。
⌘ / Ctrl + Enter 运行01
场景与操作说明
词条键与展示文本需要分开保存。翻译内容变化并不代表词条标识变化,导出时还应保留语言与命名空间。
revision 为示例修订号;是否单调递增属于实际版本规则。
- 核对 多语言词条 的字段层级,保留 messageKey 的字符串类型。
- 修改一项输入并运行,观察结果中的值或路径如何变化。
- 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02
对照样本
对照样本的 messages 为空数组,没有提供元素类型证据。生成结果不能据此证明真实接口永远返回空数组。
查看对照输入
{
"ok": true,
"data": {
"messages": [],
"summary": {
"total": 2,
"note": null
}
}
}对照样本的实际结果
// 根据样本推断;必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
"ok": boolean;
"data": {
"messages": (unknown)[];
"summary": {
"total": number;
"note": null;
};
};
};