有条件地需要 jsonSchema 属性

Question

在 jsonSchema 中，您可以使用“required”属性指示定义的字段是否是必填的:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "header": {
            "type": "object",
            "properties": {
                "messageName": {
                    "type": "string"
                },
                "messageVersion": {
                    "type": "string"
                }
            },
            "required": [
                "messageName",
                "messageVersion"
            ]
        }
    },
    "required": [
        "header"
    ]
}

在某些情况下，我希望 messageVersion 字段不是强制性的。有什么方法可以使该字段的强制性成为有条件的吗？

Answer 1

根据您的情况，有几种不同的方法。我可以想到四种不同的方法来有条件地需要一个字段。

依赖项

dependentSchemas 关键字是应用架构的条件方式。对于 dependentSchemas 中的每个属性，如果该属性存在于正在验证的 JSON 中，则与该键关联的架构也必须有效。 如果存在“foo”属性，则需要“bar”属性

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "dependentSchemas": {
    "foo": { "required": ["bar"] }
  }
}

如果所有依赖架构需求都是 required 关键字，则可以使用 dependentRequired 关键字作为简写。下面的例子和前面的例子效果一样。

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "dependentRequired": {
    "foo": ["bar"]
  }
}

注意:在 Draft-07 及以下版本中，有一个名为 dependency 的关键字。如果该值是架构，则其行为类似于 dependentSchemas。如果该值是一个数组，则其行为类似于 dependentRequired。

含义

如果您的条件取决于字段的值，您可以使用称为蕴涵的 bool 逻辑概念。 “A 暗示 B”实际上意味着，如果 A 为真，则 B 也必定为真。含义也可以表示为“!A或B”。 “foo”属性不等于“bar”，或者“bar”属性是必需的。或者，换句话说:如果“foo”属性等于“bar”，则“bar”属性是必需的

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "anyOf": [
    {
      "not": {
        "properties": {
          "foo": { "const": "bar" }
        },
        "required": ["foo"]
      }
    },
    { "required": ["bar"] }
  ]
}

如果“foo”不等于“bar”，则#/anyOf/0匹配并且验证成功。如果“foo”等于“bar”，则 #/anyOf/0 失败，并且 #/anyOf/1 必须有效才能进行 anyOf 验证取得成功。

注意:if/then 关键字具有相同的行为，但更易于阅读和维护。建议仅在您使用不支持 if/then 的旧版本 JSON 架构时才使用此方法。

枚举

如果您的条件基于枚举，则更直接一些。 “foo”可以是“bar”或“baz”。如果“foo”等于“bar”，则需要“bar”。如果“foo”等于“baz”，则需要“baz”。

{
  "type": "object",
  "properties": {
    "foo": { "enum": ["bar", "baz"] },
    "bar": { "type": "string" },
    "baz": { "type": "string" }
  },
  "anyOf": [
    {
      "properties": {
        "foo": { "const": "bar" }
      },
      "required": ["bar"]
    },
    {
      "properties": {
        "foo": { "const": "baz" }
      },
      "required": ["baz"]
    }
  ]
}

注意:不建议使用此方法，因为它可能会产生令人困惑的错误消息。 if/then 关键字通常是更好的方法。

如果-那么-否则

if、then 和 else 关键字是上述蕴含模式的简写。这些关键字是在 Draft-07 中添加的。 如果“foo”属性等于“bar”，则“bar”属性是必需的

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "if": {
    "properties": {
      "foo": { "const": "bar" }
    },
    "required": ["foo"]
  },
  "then": { "required": ["bar"] }
}

编辑 2017 年 12 月 23 日:更新了含义部分并添加了 If-Then-Else 部分。

编辑 2018 年 6 月 4 日:修复了 If-Then-Else 错误并更新单例 enum 以使用 const。

编辑 2022 年 7 月 6 日:更新“依赖项”部分以使用新的 dependentSchemas/dependentRequired 关键字，而不是 dependency.