JSON Schema 校验器

JSON 数据

1
2
3
4
5
6
7
8
9
10

JSON Schema(架构)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

校验结果

校验 JSON 数据

输入 JSON 数据与 Schema,用于校验结构与约束

校验数据类型与结构

检查 required 字段

验证约束与 format

如何用 JSON Schema 校验 JSON(步骤指南)

通过 Schema 合同校验 API 响应、配置文件与 payload 样例,可用于调试、文档化与合同测试。

  1. 步骤 1:粘贴 JSON 数据

    • 将 JSON 粘贴到 JSON 数据 编辑器中。
    • 如果 JSON 来自文件、URL 或剪贴板,可使用导入按钮。
  2. 步骤 2:粘贴 JSON Schema

    • 将 Schema 粘贴到 JSON Schema(架构) 编辑器中。
    • 优先关注核心结构: type, properties, required, items.
  3. 步骤 3:查看校验结果

    • 右侧面板会显示 valid 标记,以及 errors 列表。
    • 根据错误路径定位不匹配的具体字段。
  4. 步骤 4:修数据或修 Schema

    • 如果数据不对,修 payload(缺字段、类型错误等)。
    • 如果合同变更,更新 Schema 并重新校验。
  5. 步骤 5:在 CI 中使用严格校验器

    • 要做更严格的生产级校验(draft 支持、 $ref、组合关键字等),建议在 CI 中使用完整的 JSON Schema validator。
    • 将 Schema 版本化,并用真实 payload fixtures 做回归测试。

关于 JSON Schema 特性的提示

  • 该校验器更轻量,主要覆盖核心关键字( type, properties, required, items)。
  • 依赖 $ref, anyOf, oneOf, allOf 等关键字的 Schema 可能需要完整校验器。
示例:用 Schema 校验 JSON
// JSON data
{ "id": 1, "name": "Maeve Winters" }

// JSON Schema
{
  "type": "object",
  "properties": {
    "id": { "type": "integer" },
    "name": { "type": "string" },
    "email": { "type": "string" }
  },
  "required": ["id", "name", "email"]
}

// Result
{
  "valid": false,
  "errors": ["root: Missing required property 'email'"]
}

相关工具

生成 Schema、生成 Mock payload,并在校验前清理 JSON。

常见问题

什么是 JSON Schema 校验?

JSON Schema 校验是检查一份 JSON 是否符合指定 Schema 的过程:类型、required 字段、约束规则与结构都会被验证。

如何用 Schema 校验 JSON?

在左侧输入 JSON 数据,在中间输入 Schema。你输入时会自动触发校验并更新结果。

常见的校验错误有哪些?

常见错误包括类型不匹配、缺少 required 字段、出现不允许的额外字段、字符串长度不符合、数值范围不符合等。

可以使用自定义 JSON Schema 吗?

可以。你可以粘贴标准 JSON Schema,但该校验器更侧重 core keywords(type/properties/required/items),不解析 $ref,也不会完整计算复杂的组合关键字。

JSON Schema 校验器 | JSONSwiss