如何使用 JSON Schema 验证您的数据
什么是 JSON Schema?
JSON Schema 是一种标准化的方式,用于描述 JSON 数据的结构、必填字段和数值类型。您可以把它看作是有效 JSON 的契约或蓝图。JSON Schema 本身也是用 JSON 编写,既易于机器读取也便于编辑。
JSON Schema 不仅用于验证,还可应用于代码生成、API 文档编写和编辑器自动补全。
为何使用架构验证?
- 通过提前发现无效或缺失的数据,防止程序出现错误。
- 在不同团队、应用或 API 之间强制执行数据一致性。
- 自动从架构生成文档。
- 帮助编辑器和工具提供更智能的自动补全和内联帮助。
即使是简单的架构,也能捕获常见错误,节省大量调试时间。
简单示例:基础架构
下面是一个基本的 JSON 对象,及一个用于验证其结构的最简架构:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
该架构确保该对象必须包含一个字符串类型的“name”和一个数字类型的“age”。
如何编写自定义架构
您可以在架构中定义高级规则:限制字段值、定义嵌套对象或设置数值最小/最大值。下面是一个验证产品数组的示例:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
从简单开始:逐步构建您的架构,并使用在线验证器检查每一步。
使用 JSONValidator.dev 进行架构验证
- 将您的 JSON 数据粘贴到主编辑器中。
- 将您的 JSON Schema 粘贴到下方的架构编辑器中。
- 点击 根据此架构验证 JSON。
- 查看验证结果,错误将被标出并附有详细说明。
所有验证均在您的浏览器中完成——您的数据从不离开您的设备。
架构验证错误排查
验证错误常见原因包括:
- 您的数据缺少必填字段。
- 值的类型与架构不匹配(例如字符串与数字不符)。
- 架构本身无效或存在拼写错误。
请仔细检查错误提示,它们通常会指出具体字段和类型不匹配。
总结
JSON Schema 验证是提升数据健壮性和防错能力的强大工具。立即尝试使用我们免费的JSON Schema 生成器为您的数据创建架构,并进行实时验证吧!