专题 C1:JSON 生态
JSON Schema 校验清单
在接口或配置变更上线前,用一份可执行的 JSON Schema 清单统一字段约束、示例和回归检查。
先把契约写清楚
Schema 的价值不只是校验器能不能通过,而是让团队对必填字段、可空字段和枚举范围有一致认知。
如果接口说明、示例数据和运行时校验规则不一致,问题通常不会在开发阶段暴露,而会在联调或发布时集中爆发。
上线前至少检查这些点
- 确认 required、type、enum、format 与真实接口约束一致。
- 为嵌套对象和数组准备至少一组成功样例与一组失败样例。
- 把 Schema 校验加入 CI,避免靠人工 review 发现字段回归。
实用输入/输出示例
输入
{
"type": "object",
"required": ["id", "status"],
"properties": {
"id": { "type": "string" },
"status": { "enum": ["ready", "failed"] }
}
}输出
校验结果: - payload.id 缺失时失败 - payload.status 只能是 ready / failed