Python：jsonschema 库高级用法举例和应用详解

import jsonschema  # 导入 jsonschema 库
from jsonschema import validate  # 从库中导入 validate 方法

# 定义 JSON Schema 规范
schema = {
    "type": "object",  # 该结构必须为对象
    "properties": {  # 定义属性
        "name": {"type": "string"},  # name 属性必须是字符串
        "age": {"type": "integer"},  # age 属性必须是整数
    },
    "required": ["name", "age"],  # name 和 age 是必填项
}

# 定义要验证的 JSON 数据
data = {
    "name": "John Doe",  # 示例名字
    "age": 30  # 示例年龄
}

try:
    validate(instance=data, schema=schema)  # 验证数据是否符合 schema
    print("数据符合规范!")  # 验证通过后输出
except jsonschema.exceptions.ValidationError as e:
    print(f"数据不符合规范: {e.message}")  # 捕获异常并输出错误信息

# 定义带有嵌套结构的 JSON Schema
nested_schema = {
    "type": "object",
    "properties": {
        "user": {
            "type": "object",
            "properties": {
                "username": {"type": "string"},
                "email": {"type": "string", "format": "email"},  # email 必须是合法格式
            },
            "required": ["username", "email"],  # user 对象是必填项
        },
    },
    "required": ["user"],
}

# 定义带有嵌套结构的 JSON 数据
nested_data = {
    "user": {
        "username": "johndoe",  # 用户名
        "email": "[email protected]"  # 邮箱地址
    }
}

# 验证嵌套 JSON 数据符合其 Schema
try:
    validate(instance=nested_data, schema=nested_schema)
    print("嵌套数据符合规范!")
except jsonschema.exceptions.ValidationError as e:
    print(f"嵌套数据不符合规范: {e.message}")

# 自定义 Schema 与数据
custom_schema = {
    "type": "object",
    "properties": {
        "product": {"type": "string"},
        "price": {"type": "number", "minimum": 0},  # price 必须是非负数
    },
    "required": ["product", "price"],
}

custom_data = {
    "product": "Laptop",  # 产品名
    "price": -1500  # 价格（无效）
}

try:
    validate(instance=custom_data, schema=custom_schema)
except jsonschema.exceptions.ValidationError as e:
    # 自定义输出错误信息
    print(f"错误: {e.message} - 请确保价格为非负数!")  # 输出特定错误消息