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

仓库库存:拒绝合同以外的额外字段

本例显式声明 itemCode、itemName、available、reserved、warehouse、location,并用 additionalProperties: false 拒绝同层其他属性。这里只约束当前对象;嵌套 location 的内部属性需要另写规则。

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

示例工作台

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

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

库存接口可能同时返回仓库、库位和可用数量。对比数据前先固定仓库口径,不能把不同仓库的同一物料视作一条记录。

available 表示本例可用件数;reserved 是布尔演示标记,不是预占数量。

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

对照样本

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

查看对照输入
{
  "itemCode": "demo-inventory-1",
  "itemName": "演示物料甲",
  "available": 120,
  "reserved": true,
  "warehouse": "east",
  "location": {
    "zone": "A",
    "bins": [
      "A-01",
      "A-02"
    ]
  },
  "unexpectedDemo": true
}

对照样本的实际结果

{
  "valid": false,
  "errors": [
    {
      "instancePath": "",
      "schemaPath": "#/additionalProperties",
      "keyword": "additionalProperties",
      "params": {
        "additionalProperty": "unexpectedDemo"
      },
      "message": "must NOT have additional properties"
    }
  ]
}