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

分页搜索:约束 kind 的枚举值

本例允许 kind 为 document 或 image。枚举区分大小写;这些值只适用于此合成合同,新增业务状态时要由接口负责人更新规则。

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

示例工作台

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

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

分页返回中的当前页条数、总条数和记录排序有不同用途。本例 summary.total 仅等于这份合成数据的记录数,不能推断真实服务的分页实现。

rank 是本页展示序号,排序变化不应改写 recordId。

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

对照样本

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

查看对照输入
{
  "recordId": "demo-pagination-1",
  "headline": "搜索结果甲",
  "rank": 1,
  "selected": true,
  "kind": "unknown-demo",
  "snippet": {
    "text": "第一段摘要",
    "highlights": [
      "字段"
    ]
  }
}

对照样本的实际结果

{
  "valid": false,
  "errors": [
    {
      "instancePath": "/kind",
      "schemaPath": "#/properties/kind/enum",
      "keyword": "enum",
      "params": {
        "allowedValues": [
          "document",
          "image"
        ]
      },
      "message": "must be equal to one of the allowed values"
    }
  ]
}