JSON.CN让代码更轻
Schema 数据约束可运行案例

Webhook 事件:检查 eventId 必须存在

本例只要求 eventId 存在且为字符串。required 不自动禁止空字符串;需要非空编号时应另外增加 minLength。缺失字段的名称可在 params.missingProperty 中查看。

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

示例工作台

在完整工具中打开 ↗
Schema 数据约束修改下方数据后重新运行
运行结果
{
  "valid": true,
  "errors": []
}

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

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

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

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

对照样本

对照样本故意违反 required。这是已完成的校验,预期 valid 为 false;核对 errors 的 keyword、instancePath 和 params。

查看对照输入
{
  "eventName": "演示创建事件",
  "attempt": 1,
  "delivered": true,
  "eventType": "created",
  "payload": {
    "resourceId": "demo-R01",
    "changes": [
      "name"
    ]
  }
}

对照样本的实际结果

{
  "valid": false,
  "errors": [
    {
      "instancePath": "",
      "schemaPath": "#/required",
      "keyword": "required",
      "params": {
        "missingProperty": "eventId"
      },
      "message": "must have required property 'eventId'"
    }
  ]
}