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

用户列表：检查 userId 必须存在

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

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

示例工作台

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

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

用户列表通常同时包含标识、展示名称、状态和资料。联调时先区分展示字段与权限字段，不能用昵称替代用户标识。

loginCount 是示例累计登录次数；0 是有效值，不应当成字段缺失。

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

对照样本

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

查看对照输入
{
  "displayName": "示例用户甲",
  "loginCount": 12,
  "active": true,
  "role": "reader",
  "profile": {
    "city": "杭州",
    "tags": [
      "new",
      "web"
    ]
  }
}

对照样本的实际结果

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