如何在 json 模式中表示 sum/union 类型

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" }
    }
}