2 oneOf在json架构中:1需要1个可选

时间:2016-12-14 15:21:09

标签: json schema field optional

我有一个json架构,当我在必需字段之间使用2 oneOf进行2次选择时,它可以正常工作。但我不知道如何对可选字段做同样的事情。

我的架构:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "a": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "c": {
      "type": "number"
    },
    "d": {
      "type": "number"
    },
    "e": {
      "type": "number"
    }
  },
  "required": ["a"],
  "oneOf": [
    {"required": ["b"]},
    {"required": ["c"]}
  ],
  "oneOf": [
    {"required": ["d"]},
    {"required": ["e"]}
  ]
}

如何进行转换以使d和e成为可选(同时从不同时使用)?

1 个答案:

答案 0 :(得分:3)

这里是gist with my solution,显示在http://jsonschemalint.com中。 (非常方便的工具!)

已定义属性de,并允许(但不要求)任何组合。为了使这两个属性互斥,我们说实例必须not匹配具有这两个属性的模式:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "a": {"type": "number"},
    "b": {"type": "number"},
    "c": {"type": "number"},
    "d": {"type": "number"},
    "e": {"type": "number"}
  },
  "required": ["a"],
  "oneOf": [
      {"required": ["b"]},
      {"required": ["c"]}
    ],
  "not" : {"required" : ["d","e"]}
}

这很好用,但如果你的互斥组中有两个以上的属性,它就会变得混乱。例如,如果我们想要添加属性f并使其与de互斥,我们必须禁止三种不同的组合:

  "not" : {
    "anyOf"{
      {"required" : ["d","e"]},
      {"required" : ["d","f"]},
      {"required" : ["e","f"]},
    }
  }

这是一个更加冗长的替代方案,但可扩展到更大的互斥属性集:

  "oneOf" : [
    {"required" : ["d"]},
    {"required" : ["e"]},
    {"required" : ["f"]},
    {
      "not" : {
        "anyOf" : [
          {"required" : ["d"]},
          {"required" : ["e"]},
          {"required" : ["f"]}
        ]
      }  
    }
  ]

添加到组中的每个属性都需要两行。

由于我们的架构现在有两个oneOf约束,我们需要使用allOf组合它们:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "a": {"type": "number"},
    "b": {"type": "number"},
    "c": {"type": "number"},
    "d": {"type": "number"},
    "e": {"type": "number"},
    "f": {"type": "number"}
  },
  "required": ["a"],
  "allOf": [
    {
      "oneOf": [
          {"required": ["b"]},
          {"required": ["c"]}
        ]
    },
    {
      "oneOf" : [
        {"required" : ["d"]},
        {"required" : ["e"]},
        {"required" : ["f"]},
        {
          "not" : {
            "anyOf" : [
              {"required" : ["d"]},
              {"required" : ["e"]},
              {"required" : ["f"]}
            ]
          }  
        }
      ]
    }
  ]
}