开发者指南
发布前如何校验 JSON Schema
合法 JSON 不一定是正确 JSON。发布 API 示例、配置文件或 fixture 前,应校验结构、必填字段、类型和调用方依赖的边界情况。
区分语法和结构
格式化检查能发现逗号和括号问题;Schema 检查能发现缺失字段、类型错误、枚举无效和嵌套对象不符合契约。
校验文档中的示例
文档示例经常被复制使用。它们应保持有效、接近真实,同时不能包含真实客户数据或秘密。
检查可选和必填字段
确认必填字段存在,可选字段在缺失、null、空值或异常值时也符合预期。
对比 fixture 变更
修改 fixture 时,对比新旧版本,让审查者清楚看到哪些字段被添加、删除或重命名。
敏感值使用假数据
使用逼真但虚假的 ID、邮箱、token 和名称。不要把生产 payload 粘贴到公开页面或工单里作为校验样本。
相关工具
JSON Toolbox 可本地格式化和检查 payload;用 Diff Checker 审查 fixture 变更。