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

订单响应:检查 orderId 必须存在

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

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

示例工作台

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

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

订单返回中,订单号用于关联记录,数量用于计算,支付标记和流程状态分别表达不同信息。下面使用两条订单及各自的配送明细,练习提取标识、核对数量类型和定位状态变化。

quantity 为本例商品件数;金额应另行约定精度与币种。

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

对照样本

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

查看对照输入
{
  "subject": "演示订单甲",
  "quantity": 2,
  "paid": true,
  "status": "pending",
  "delivery": {
    "city": "北京",
    "items": [
      {
        "sku": "A01",
        "count": 2
      }
    ]
  }
}

对照样本的实际结果

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