根据包含多个模式定义的JSON模式进行验证

Question

我正在创建一个用于Postman的JSON模式，其中包含一些模式定义。我针对模式验证的JSON需要与模式定义之一匹配。

示例模式

{
  "oneOf": [
    {
      "$ref": "#/definitions/schema1"
    },
    {
      "$ref": "#/definitions/schema2"
    },
    {
      "$ref": "#/definitions/schema3"
    }
  ],
  "definitions": {
    "schema1": {
      "type": "object",
      "properties": {
        "propertyA": {
          "type": "string"
        }
      },
      "required": [
        "propertyA"
      ]
    },
    "schema2": {
      "type": "object",
      "properties": {
        "propertyB": {
          "type": "string"
        }
      },
      "required": [
        "propertyB"
      ]
    },
    "schema3": {
      "type": "object",
      "properties": {
        "propertyC": {
          "type": "string"
        }
      },
      "required": [
        "propertyC"
      ]
    }
  }
}

JSON数据示例

此JSON根据模式进行验证，并正确标记为无效（因为需要字符串）：

{
    "propertyA": 123
}

问题

此示例根据https://www.jsonschemavalidator.net/返回4个错误：

• 消息：JSON对“oneOf”中的任何模式都无效。模式路径：#/oneOf

我只对错误消息感兴趣，它说它需要一个字符串。如何在将架构定义保存在一个文件中的同时避免这些其他错误消息？

Answer 1

是的，oneOf对于这种事情来说很糟糕。如果/那么很冗长，但会给你更好的结果。基本上，您需要确定一些决定模式是否应适用于实例的条件。

通常，该条件是公共字段的值。在这种情况下，如果正在验证的实例是一个具有“type”：“A”的对象，那么它必须根据/definitions/A模式进行验证。如果它有“type”：“B”，那么它必须根据/definitions/B模式进行验证。

{
  "allOf": [
    {
      "if": {
        "properties": {
          "type": { "const": "A" }
        },
        "required": ["type"]
      },
      "then": { "$ref": "#/definitions/a" }
    },
    {
      "if": {
        "properties": {
          "type": { "const": "B" }
        },
        "required": ["type"]
      },
      "then": { "$ref": "#/definitions/b" }
    }
  ]
}

如果您的条件是存在特定字段，您可以使用依赖项关键字作为快捷方式。如果被验证的实例是具有“属性A”属性的对象，则该实例必须对/定义/a模式有效。同样对于“属性B”。

{
  "dependencies": {
    "propertyA": { "$ref": "#/definitions/a" },
    "propertyB": { "$ref": "#/definitions/b" }
  }
}

您的示例实际上有一个非常简单的解决方案，但我回答了一般情况，因为我假设您的实际模式比示例更复杂。

{
  "type": "object",
  "properties": {
    "propertyA": { "type": "string" },
    "propertyB": { "type": "string" },
    "propertyC": { "type": "string" }
  },
  "oneOf": [
    { "required": ["propertyA"] },
    { "required": ["propertyB"] },
    { "required": ["propertyC"] }
  ]
}