JSON Schema 是用于描述 JSON 数据结构的元数据格式,可定义数据的格式、类型、约束等规则。它是 JSON 数据的「蓝图」,常用于数据验证和文档说明。
核心作用 ✅
- 数据校验:确保 JSON 数据符合预设结构
📌 示例:验证用户信息是否包含必填字段 - 文档规范:清晰展示 API 接口的数据要求
📌 示例:定义请求参数的格式与范围 - 工具支持:与 JSON 验证工具(如
jsonschema
库)无缝兼容
基本结构 🧩
{
"$schema": "http://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {"type": "string", "description": "用户姓名"},
"age": {"type": "integer", "minimum": 0}
},
"required": ["name", "age"]
}
常见用例 📦
- API 接口文档(如
/json/usage
) - 配置文件验证
- 数据交换格式标准化