JSON Schema 验证指南

创作时间:

作者:

@小白创作中心

JSON Schema 验证指南

引用

来源

https://apifox.com/apiskills/how-to-validate-json-schema/

在踏上复杂的数据验证领域的旅程中，我们发现自己正处于探索 JSON Schema 关键领域的风口浪尖。进入 JSON Schema 验证的世界，并不只是关于遵循规则和标准，更是一场追求数据质量、保证数据一致性和抵御不确定性的挑战。本文将为开发者、数据人员提供清晰易懂的讲解，帮助更好地理解和强化对 JSON Schema 的认识。

JSON Schema 是什么？

我们首先需要了解一些基本知识。 JSON Schema 就像是数据世界中的管理员，它由一套规则构成，用来描述JSON数据的结构。比如说，你正在搭建一座乐高城堡，那么 JSON Schema 就相当于搭建说明书，提供如何正确组装和构架的规则，确保你所有的数据部分都在正确的位置，不会漏掉任何重要的部分。

from jsonschema import validate
from jsonschema.exceptions import ValidationError

# Our JSON Schema
schema = {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "age": {"type": "number", "minimum": 18},
    "email": {"type": "string", "format": "email"}
  },
  "required": ["name", "email"]
}

# Sample JSON data
user_data = {
  "name": "Jamie",
  "age": 25,
  "email": "jamie@example.com"
}

# Let's validate
try:
    validate(instance=user_data, schema=schema)
    print("Hooray! Your JSON data is as good as gold.")
except ValidationError as e:
    print("Oops! There's a problem with your data:", e.message)

为什么要验证JSON Schema？

JSON Schema 验证

验证 JSON 响应架构可确保使用的数据准确、可靠且完全符合预期。这就像在门口检查邀请函一样。如果数据不符合架构，则无法进入。这对于维护数据完整性、提高数据质量以及避免应用程序中出现与数据相关的错误至关重要。

验证 JSON Schema 步骤

第 1 步：熟悉 JSON Schema

我们需要熟悉并理解关于 JSON 模式的语法和功能。

查看不同的数据类型（
string
、
number
、
object
、
array
、
boolean
、
null
、
properties
、
items
、
required
等属性，和验证关键字（
minLength
、
maximum
、
pattern
等）。

第 2 步：定义 JSON Schema

现在我们已经初步了解 JSON Schema了，我们就可以来确定我们的架构，定义 JSON 数据应遵循的规则和结构。

确定结构：确定数据主要是对象、数组还是简单类型。
定义属性：对于数据中的每个元素，指定其应满足的类型及其任何约束或附加要求。
指定必填字段：标记哪些字段是必填字段，以确保不会遗漏重要数据。

这里有个简单的用户配置文件架构示例：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "age": {
      "type": "number",
      "minimum": 18
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  },
  "required": ["name", "age", "email"]
}