确保数组中的项目属性在 Json Schema 中是唯一的？

Question

鉴于以下 JSON 模式，是否可以指示“名称”属性应是唯一的（即“元素”数组中不应有两个具有相同“名称”的项目。

{
  "root": {
    "type": "object",
    "properties": {
      "elements": {
        "type": "array",
        "minItems": 1,
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "title": "Element Name",
              "minLength": 3,
            },
            "url": {
              "type": "string",
              "title": "Some URL"
            }
          }
        }
      }
    }
  }
}

我尝试使用 uniqueItems 关键字，但它似乎是为简单的值列表设计的。

Answer 1

不，这是不可能的。来自文档，json-schema：...一种基于 JSON 的格式，用于定义 JSON 数据的结构。

进行数据值验证非常有限，因为它不是标准的目的。很多人之前都问过这个问题，因为请求一种“唯一 ID”功能是很常见的。不幸的是，对于那些需要它的人，json-schema 并没有为您提供。

因此，如果您想确保唯一性，您唯一的选择是将“名称”作为属性键而不是属性值。

Answer 2

如果重构数据结构是一种选择，以下方法可能会有所帮助：

• 用地图替换数组。这可以通过使用带有patternProperties 的对象轻松实现。该模式是一个正则表达式。任何与模式匹配的对象都将根据模式属性的模式进行验证。匹配任何字符串 >= 3 个字符的模式如下所示："....*"，但似乎总是隐含尾随 ".*"，因此 "..." 也可以。
• 添加 additionalProperties:false 是强制执行约束的额外步骤 (minLength:3)。
• 要强制映射中的至少一个元素（您的数组使用minItems:1），请将minItems 替换为minProperties。

...导致以下架构：

"root": {
  "type": "object", 
  "properties": {
    "elements": {
      "type": "object", 
      "patternProperties": {
        "...": {
          "type": "object", 
          "properties": {
            "url": {
              "type": "string"
            }
          }
        }
      }, 
      "additionalProperties": false, 
      "minProperties": 1
    }
  }
}

如果类似以下（摘录）的文档与您的旧架构相匹配，

"elements": [
  {
    "name": "abc", 
    "url": "http://myurl1"
  }, 
  {
    "name": "def", 
    "url": "http://myurl2"
  }, 
  {
    "name": "ghij", 
    "url": "http://myurlx"
  }
]

...这样的文档（摘录）将匹配新架构：

"elements": {
  "abc": {
    "url": "http://myurl1"
  }, 
  "def": {
    "url": "http://myurl2"
  }, 
  "ghij": {
    "url": "http://myurlx"
  }
}

Answer 3

如果您的用例可以处理增加的开销，您可以对文档应用转换以生成精简文档，然后在精简文档上使用单独的迷你模式再次应用验证。

以下是一些关于 Json 转换工具信息的链接：

• JSONata.
• A SO thread on Json transformation.

在 JSONata 中处理您的示例案例非常简单。

Answer 4

对于 Ajv 验证器，您可以使用自定义 JSON-Schema 关键字 uniqueItemProperties ： ajv-validator/ajv-keywords