json - 如何在json模式中表示求和/联合类型

Question

我正在尝试使用json-schema记录JSON的现有用法。系统允许对象属性之一具有以下两种可能性。

要么

{
    "tracking_number" : 123
}

要么

{
    "tracking_number" : [ 123, 124, 125 ]
}

我如何使用json模式表达这一点？

Answer 1

使用anyOf断言该属性必须符合一个或另一个模式。

{
    "type": "object",
    "properties": {
        "tracking_number": {
            "anyOf": [
                { "$ref": "#/definitions/tracking_number" },
                { "type": "array", "items": { "$ref": "#/definitions/tracking_number" }
            ]
    },
    "definitions": {
        "tracking_number": { "type": "integer" }
    }
}