如何仅在其他属性不存在时才允许一个属性并允许 json 模式中的任何其他属性答案

【问题标题】：How to allow one property only if other is not present and allow any of other propeties in json schema如何仅在其他属性不存在时才允许一个属性并允许 json 模式中的任何其他属性
【发布时间】：2018-11-30 19:13:06
【问题描述】：

我有六个属性：姓名、年龄、电话、deletePhone、地址、deleteAddress。

我想创建允许上述任何属性的架构，但电话不应出现在 deletePhone 中，并且地址不应出现在 deleteAddress 中（反之亦然）。

我已经尝试过这个架构：

{
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      },
      "age": {
        "type": "number"
      },
      "phone": {
        "type": "number"
      },
      "deletePhone": {
        "type": "boolean"
      },
      "address": {
        "type": "string"
      },
      "deleteAddress": {
        "type": "boolean"
      }
    },
    "allOf": [
      {
        "oneOf": [
          {
            "required": ["phone"]
          },
          {
            "required": ["deletePhone"]
          }
        ]
      },
      {
        "oneOf": [
          {
            "required": ["address"]
          },
          {
            "required": ["deleteAddress"]
          }
        ]
      }
    ]
}

验证为真

{
    "name": "my name",
    "address": "some addr",
    "phone": 34
}

并验证为假

{
    "address": "some addr",
    "phone": 34,
    "deletePhone": true
}

这是正确的，但它也验证为假

{
    "phone": 34
}
or
{
    "name": "some name"
}

我想验证的是真的，我知道我错过了 anyOf、oneOf 的某种组合，或者有没有更好的方法？

【问题讨论】：

如果您可以访问支持最新草案 (draft-7) 的实现，您可能需要查看规范中的 if then else 关键字。如果没有，还有办法，但更做作。抱歉，我现在不能写答案。

标签： json jsonschema

【解决方案1】：

我认为这是最简单的解决方案。

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "number" },
    "phone": { "type": "number" },
    "deletePhone": { "type": "boolean" },
    "address": { "type": "string" },
    "deleteAddress": { "type": "boolean" }
  },
  "allOf": [
    { "not": { "required": ["phone", "deletePhone"] } },
    { "not": { "required": ["address", "deleteAddress"] } }
  ]
}

【讨论】：

漂亮！只是缺少"additionalProperties": false。
没有遗漏，故意遗漏。有一天我将不得不写一篇“被认为有害的附加属性”博文。
不错的解决方案，但是，最好在本机上支持这一点，以便错误消息告诉这种情况下的一些特定错误，例如“应该有电话或删除电话”

【解决方案2】：

编辑：一种不同但更可靠和紧凑的方法。

{
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "age": {"type": "number"},
    "phone": {"type": "number"},
    "deletePhone": {"type": "boolean"},
    "address": {"type": "string"},
    "deleteAddress": {"type": "boolean"}
  },
  "additionalProperties": false,
  "allOf": [
    {
      "oneOf": [
        {
          "allOf": [
            {"required": ["phone"]},
            {"not":{"required":["deletePhone"]}}
          ]
        },
        {
          "allOf": [
            {"required": ["deletePhone"]},
            {"not":{"required":["phone"]}}
          ]
        },
        {
          "allOf": [
            {"not":{"required": ["deletePhone"]}},
            {"not":{"required":["phone"]}}
          ]
        }
      ]
    },
    {
      "oneOf": [
        {
          "allOf": [
            {"required": ["address"]},
            {"not":{"required":["deleteAddress"]}}
          ]
        },
        {
          "allOf": [
            {"required": ["deleteAddress"]},
            {"not":{"required":["address"]}}
          ]
        },
        {
          "allOf": [
            {"not":{"required": ["deleteAddress"]}},
            {"not":{"required":["address"]}}
          ]
        }
      ]
    }
  ]
}

用ajv测试：https://runkit.com/embed/5qwkquyweir2

旧（不工作）：

如果您可以允许null 值等于不存在的属性，那么架构可能就这么简单：

{
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "age": {"type": "number"}
  },
  "allOf": [
    {
      "oneOf": [
        {
          "properties": {
            "phone": {"type": "number"},
            "deletePhone": {"type": "null"}
          },
          "required": ["phone"]
        },
        {
          "properties": {
            "phone": {"type": "null"},
            "deletePhone": {"type": "boolean"}
          },
          "required": ["deletePhone"]
        },
        {}
      ]
    },
    {
      "oneOf": [
        {
          "properties": {
            "address": {"type": "string"},
            "deleteAddress": {"type": "null"}
          },
          "required": ["address"]
        },
        {
          "properties": {
            "address": {"type": "null"},
            "deleteAddress": {"type": "boolean"}
          },
          "required": ["deleteAddress"]
        },
        {}
      ]
    }
  ]
}

但是如果你不能让{"deletePhone":null,"phone":123}架构更加复杂和重复：

{
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "age": {"type": "number"}
  },
  "allOf": [
    {
      "oneOf": [
        {
          "properties": {
            "name": {},
            "age": {},
            "address": {},
            "deleteAddress": {},
            "phone": {"type": "number"}
          },
          "required": ["phone"],
          "additionalProperties": false
        },
        {
          "properties": {
            "name": {},
            "age": {},
            "address": {},
            "deleteAddress": {},
            "deletePhone": {"type": "boolean"}
          },
          "required": ["deletePhone"],
          "additionalProperties": false
        },
        {}
      ]
    },
    {
      "oneOf": [
        {
          "properties": {
            "name": {},
            "age": {},
            "phone": {},
            "deletePhone": {},
            "address": {"type": "string"}
          },
          "required": ["address"],
          "additionalProperties": false
        },
        {
          "properties": {
            "name": {},
            "age": {},
            "phone": {},
            "deletePhone": {},
            "deleteAddress": {"type": "boolean"}
          },
          "required": ["deleteAddress"],
          "additionalProperties": false
        },
        {}
      ]
    }
  ]
}

【讨论】：

您的第二个解决方案验证 {"phone": 34} 为 false，第一个解决方案也不适用于您给定的示例。当您在 oneOf 中使用 {} 时，它不会再次匹配任何导致它失败的 json {"phone": 34}，因为它会匹配 oneOf 中的两个架构。
确实我的解决方案不能正常工作，请尝试更新答案中的架构

【解决方案3】：

以下架构适用于所有情况，但很长。

{
  "type": "object",
    "oneOf": [
      {
        "anyOf": [
          {
            "oneOf": [
              {
                "properties": {
                  "phone": {
                    "type": "number"
                  },
                  "address": {
                    "type": "string"
                  },
                  "deleteAddress": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "phone"
                ],
                "not": {
                  "required": [
                    "deletePhone"
                  ]
                }
              },
              {
                "properties": {
                  "deletePhone": {
                    "type": "boolean"
                  },
                  "address": {
                    "type": "string"
                  },
                  "deleteAddress": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "deletePhone"
                ],
                "not": {
                  "required": [
                    "phone"
                  ]
                }
              },
              {
                "oneOf": [
                  {
                    "required": [
                      "phone",
                      "address",
                      "deleteAddress"
                    ]
                  },
                  {
                    "required": [
                      "deletePhone",
                      "address",
                      "deleteAddress"
                    ]
                  }
                ]
              }
            ]
          },
          {
            "oneOf": [
              {
                "properties": {
                  "address": {
                    "type": "string"
                  },
                  "phone": {
                    "type": "number"
                  },
                  "deletePhone": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "address"
                ],
                "not": {
                  "required": [
                    "deleteAddress"
                  ]
                }
              },
              {
                "properties": {
                  "deleteAddress": {
                    "type": "boolean"
                  },
                  "phone": {
                    "type": "number"
                  },
                  "deletePhone": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "deleteAddress"
                ],
                "not": {
                  "required": [
                    "address"
                  ]
                }
              },
              {
                "oneOf": [
                  {
                    "required": [
                      "address",
                      "phone",
                      "deletePhone"
                    ]
                  },
                  {
                    "required": [
                      "deleteAddress",
                      "phone",
                      "deletePhone"
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "properties": {
          "name": {
            "type": "string"
          },
          "age": {
            "type": "number"
          }
        },
        "additionalProperties": false
      }
    ]
}

【讨论】：