JSON Schema验证使用教程:从入门到精通

什么是 JSON Schema 验证?

JSON Schema 验证是一种通过预定义的 Schema 规则来检查 JSON 数据是否符合预期结构的技术。它就像一份"数据检查清单",确保传入的 JSON 数据包含必需的字段、字段类型正确、值在合法范围内。从 API 开发到配置文件管理,JSON Schema 验证是保障数据质量的第一道防线。

逐步操作指南

第一步:准备你的 Schema 和 JSON 数据

首先,你需要一份 JSON Schema 定义和待验证的 JSON 数据。

Schema 定义(schema.json):

json 复制代码
{
  "$schema": "https://json-schema.org/draft-07/schema",
  "type": "object",
  "properties": {
    "username": { "type": "string", "minLength": 3, "maxLength": 20 },
    "age": { "type": "integer", "minimum": 0, "maximum": 150 },
    "email": { "type": "string", "format": "email" }
  },
  "required": ["username", "email"]
}

待验证数据(data.json):

json 复制代码
{
  "username": "小明",
  "age": 25,
  "email": "xiaoming@example.com"
}

第二步:进入验证工具

打开 星点网 JSON Schema 验证器,你会看到三个区域:Schema 输入区、数据输入区和结果展示区。

第三步:粘贴并验证

  1. 将 Schema 粘贴到左侧输入框
  2. 将 JSON 数据粘贴到右侧输入框
  3. 点击"验证"按钮
  4. 查看验证结果:通过或报错详情

第四步:理解验证结果

验证通过时会显示绿色提示;验证失败时,工具会明确告诉你:

  • 哪个字段 不符合规则(如 age 字段)
  • 期望什么类型/值 (如期望 integer,实际为 string
  • 具体路径 (如 $.data.user.age

常见验证操作

  • 类型验证:检查字段是否为 string、number、boolean、object、array 等
  • 范围验证:检查数字是否在 min/max 范围内
  • 正则匹配:通过 pattern 检查字符串格式
  • 枚举验证:检查值是否在 enum 列表中
  • 嵌套验证:递归检查深层嵌套的对象
  • 数组验证:检查数组长度、元素类型等

总结

JSON Schema 验证是确保数据质量最可靠的手段之一。使用星点网 JSON Schema 验证器,你可以快速找出 JSON 数据与规范之间的差异,让数据验证变得简单高效。

更多在线工具,请访问 星点网 xingdian.net 免费使用。