GUIDE深度 · Deep dive

API JSON 校验:类型、可选字段和版本

后端加字段通常兼容,删字段/改类型会破坏前端。生成类型后,用 Zod/Valibot 等做运行时校验,并为可选字段/版本化响应写测试;不要把示例 JSON 当契约。

更新 2026-10-31 · 公式可核验

校验策略

入口处校验外部 JSON。

可选字段给默认值。

未知字段决定忽略/拒绝。

版本化

响应加版本/契约测试。

删除字段先弃用再移除。

常见问题

TS 类型能保证 API 吗?

不能;运行时校验才保证。

多余字段要报错吗?

看兼容策略;严格模式可拒绝,宽松模式忽略。

数据来源

相关计算器

JSON 转 TypeScript粘贴 JSON,生成 interface/type;数组对象合并字段、缺失字段可选,本地处理不上传。

更多指南

JSON 转 TypeScript:interface 还是 type阅读指南