编写更复杂的json模式,这些模式依赖于其他键

Question

我一直在编写简单的JSON模式,但我遇到了一个更复杂的API输入调用.我有一个宁静的结束路线,可以采用3种非常不同类型的JSON:

本地主机/富

可以采取:

{"type":"ice_cream","cone":"waffle"......}

要么

{"type":"hot_dog","bun":"wheat"......}

如果"type"键包含"ice_cream",我只想看到键"cone"而不是键"bun".同样,如果"type"包含"hot_dog",我只想看"bun"而不是"cone".我知道我可以模式匹配,以确保我只看到类型"ice_cream"或键入"hot_dog",但我不知道如果该键设置为该值,如何强制某些其他字段的要求.我看到有一个名为"依赖"的json架构字段,但我没有找到任何关于如何使用它的好例子.

顺便说一句,我不确定这个输入JSON是否是一个好形式(有效地重载它所采用的JSON结构的类型),但我没有更改api的选项.

Answer 1

我终于得到了一些关于此的信息 - 事实证明，您可以将几个有效的不同对象进行联合，如下所示：

{
    "description" : "Food",
    "type" : [
        {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "type" : "string",
                    "required" : true,
                    "enum": [
                        "hot_dog"
                    ]
                },
                "bun" : {
                    "type" : "string",
                    "required" : true 
                },
                "ketchup" : {
                    "type" : "string",
                    "required" : true 
                } 
            } 
        },
        {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "type" : "string",
                    "required" : true,
                    "enum": [
                        "ice_cream"
                    ]
                },
                "cone" : {
                    "type" : "string",
                    "required" : true 
                },
                "chocolate_sauce" : {
                    "type" : "string",
                    "required" : true 
                } 
            } 
        }
    ]
}

我仍然不确定这是否是有效的 JSON，因为我的 Schemavalidator 因某些无效输入而终止，但它按预期接受有效输入。