理解 JSON Schema：验证您的数据结构

jsonschemavalidation

JSON Schema 是一种用于验证 JSON 数据结构的强大词汇表。它让您可以定义 JSON 文档必须遵循的规则。

什么是 JSON Schema？

JSON Schema 本身是一个 JSON 文档，描述其他 JSON 文档的预期形状：

{


  "$schema": "https://json-schema.org/draft/2020-12/schema",


  "type": "object",


  "properties": {


    "name": { "type": "string", "minLength": 1 },


    "age": { "type": "integer", "minimum": 0 },


    "email": { "type": "string", "format": "email" }


  },


  "required": ["name", "email"]


}

关键特性

  • 类型检查 — 验证字符串、数字、布尔值、数组、对象

  • 必填字段 — 确保必要属性存在

  • 范围验证 — 最小/最大值和字符串长度

  • 模式匹配 — 用于字符串验证的正则表达式

  • 嵌套模式 — 验证复杂的深层嵌套结构

    • 常见用例

  • API 请求验证 — 确保客户端发送格式正确的数据

  • 配置验证 — 尽早捕获配置错误

  • 表单验证 — 从模式生成表单

  • 文档 — 模式作为活的文档

    • 工具和库

  • Ajv — 快速的 JavaScript JSON Schema 验证器

  • jsonschema — Python JSON Schema 验证器

  • 在线验证器 — 无需代码的快速验证

    • 先用我们的 JSON 验证器 验证 JSON 语法，然后使用 JSON Schema 进行结构验证。

    相关工具