在 OpenAPI 3.1 中，什么等同于多类型？anyof or oneOf？

Question

我想将多个类型(在JSON Schema的最新草案中支持，OpenAPI v3.1也支持)更改为< code>anyOf，< code>oneOf，但是我有点搞不清楚这些类型应该映射到哪个类型。或者我可以映射到两者中的任何一个。

另外，我确实了解＜code＞任何＜/code＞、＜code＞其中一个＜/code＞等。但多种类型的行为有点模棱两可。（我知道模式是无效的，但这只是一个更侧重于类型转换的示例。）

{
    "type": ["null", "object", "integer", "string"],
    "properties": {
        "prop1": {
            "type": "string"
        },
        "prop2": {
            "type": "string"
        }
    },
    "enum": [2, 3, 4, 5],
    "const": "sample const entry",
    "exclusiveMinimum": 1.22,
    "exclusiveMaximum": 50,
    "maxLength": 10,
    "minLength": 2,
    "format": "int32"
}

我是这样转换的。

{
    "anyOf": [{
            "type": "null"
        },
        {
            "type": "object",
            "properties": {
                "prop1": {
                    "type": "string"
                },
                "prop2": {
                    "type": "string"
                }
            }
        },
        {
            "type": "integer",
            "enum": [2, 3, 4, 5],
            "exclusiveMinimum": 1.22,
            "exclusiveMaximum": 50,
            "format": "int32"
        },
        {
            "type": "string",
            "maxLength": 10,
            "minLength": 2,
            "const": "sample const entry"
        }
    ]
}

Answer 1

匿名用户

首先，你举的例子不成立:

>

初始架构与任何内容都不匹配，它是一个“不可能”的架构。“枚举”：[2， 3， 4， 5] 和 “const”： “sample const entry” 约束是互斥的，“const”：“sample const entry”和 “maxLength”：10 也是如此。

重写的架构不等同于原始架构，因为枚举和 const 已从根级别移动到子方案。是的，通过这种方式，模式更有意义，并且会起作用（例如，它将匹配指定的数字 - 但不是字符串！因为const vs maxLength矛盾），但它与原始模式不同。

视情况而定。

在< code>anyOf和< code>oneOf之间的选择取决于上下文，即一个实例是可以匹配多个子模式还是恰好匹配一个子模式。换句话说，多个子模式匹配被认为是OK还是错误。可空引用通常需要< code>anyOf，而不是< code>oneOf，但其他情况因模式而异。

例如

"type": ["number", "integer"]

而

"type": ["string", "integer"]

可以使用 oneOf 或 anyOf 来表示。oneOf在语义上更接近，因为字符串和整数是完全不同的数据类型，没有重叠。但从技术上讲，anyOf也有效，只是在这种特殊情况下不会有多个子序列匹配。

在您的示例中，所有基本的< code>type值都是不同的，没有重叠，因此我将使用< code>oneOf，但是从技术上讲< code>anyOf也可以。

Answer 2

anyOf 为您提供了比 oneOf 更接近语义的匹配;

问题（或好处！）的一个原因是，如果恰好匹配两种不同的情况，它将失败。

例如，想象一下转换[“整数”，“数字”];如果输入为 1，则两者都匹配，并使用 oneOf 失败。