JSON.CN让代码更轻
JSON 整理与类型生成可运行案例

Webhook 事件：从样本起草 Draft-07 Schema

从 Webhook 事件 的样本推断字段与类型。样本无法证明全部必填项、合法范围和业务状态，发布前应补正常与异常样本，再用 Schema 校验工具核对。

浏览器本地处理合成数据同场景 32 个案例 ↗
试一试

示例工作台

在完整工具中打开 ↗
JSON 整理与类型生成修改下方数据后重新运行
运行结果
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "events": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "eventId": {
                "type": "string"
              },
              "eventName": {
                "type": "string"
              },
              "attempt": {
                "type": "integer"
              },
              "delivered": {
                "type": "boolean"
              },
              "eventType": {
                "type": "string"
              },
              "payload": {
                "type": "object",
                "properties": {
                  "resourceId": {
                    "type": "string"
                  },
                  "changes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "resourceId",
                  "changes"
                ]
              }
            },
            "required": [
              "eventId",
              "eventName",
              "attempt",
              "delivered",
              "eventType",
              "payload"
            ]
          }
        },
        "summary": {
          "type": "object",
          "properties": {
            "total": {
              "type": "integer"
            },
            "note": {
              "type": "null"
            }
          },
          "required": [
            "total",
            "note"
          ]
        }
      },
      "required": [
        "events",
        "summary"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}

原例已核验，可修改输入后重新运行。

⌘ / Ctrl + Enter 运行
01

场景与操作说明

Webhook 事件的投递次数与资源变更内容属于不同层级。此案例只检查事件样本，不向回调地址发送请求，也不证明签名或幂等逻辑正确。

attempt 是演示投递次数，delivered 仅表示样本中的布尔值。

  1. 核对 Webhook 事件 的字段层级，保留 eventId 的字符串类型。
  2. 修改一项输入并运行，观察结果中的值或路径如何变化。
  3. 载入对照样本，复现下面的变化；恢复原例会替换当前输入。
02

对照样本

对照样本没有 events 元素，无法推断元素结构。比较两份 Schema，确认哪些约束来自样本证据，哪些仍需人工补充。

查看对照输入
{
  "ok": true,
  "data": {
    "events": [],
    "summary": {
      "total": 2,
      "note": null
    }
  }
}

对照样本的实际结果

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "events": {
          "type": "array",
          "items": {}
        },
        "summary": {
          "type": "object",
          "properties": {
            "total": {
              "type": "integer"
            },
            "note": {
              "type": "null"
            }
          },
          "required": [
            "total",
            "note"
          ]
        }
      },
      "required": [
        "events",
        "summary"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}