如何从json模式

时间:2017-09-05 04:02:30

标签: jsonschema

我有一个json架构,我有3种媒体,标题,图片和头像。

每种媒体类型都有不同的结构,因此我使用$refoneOf来指定哪些是有效选项。

但是,我无法弄清楚如何根据兄弟的值来指定使用哪个引用。

我的架构看起来像这样

const mediaSchema = {
    "type": "object",
    "required": ["mediaType", "content", "points"],
    "properties":{
        "mediaType": {"type":"string", "pattern": "^(image|avatar|caption)$"},
        "content": {
            "oneOf": [
                {"$ref":"#/definitions/image"},
                {"$ref": "#/definitions/caption"},
                {"$ref": "#/definitions/avatar"}
            ],
        }
    },
    "definitions": {
        "caption": 
            {"type": "object",
                "required": ["text"],
                "properties": {
                    "text": {"type": "string"},
                    "fontSize": {"type": "string", "pattern": "^[0-9]{1,3}px$"}
            }
        },
        "image": {"type": "string", "format": "url"},
        "avatar": 
            {"type": "object",
                "properties": {
                    "name": {"type": "string"},
                    "image": {"type": "string", "format":"url"}
            }
        }
    }
}

当我定义像

这样的头像时
mediaItem = {
    "mediaType":"avatar",
    "content": {
         "name": "user name",
         "avatar": "https://urlToImage
     }
}

它应该有效,但如果我将头像定义为

mediaItem = {
    "mediaType": "avatar",
    "content": "https://urlToImage"
}

它应该抛出错误,因为它对于媒体类型的头像无效。

1 个答案:

答案 0 :(得分:1)

您走在正确的轨道上,但是您应该将oneOf调度程序放到架构的根目录中,并将"content"定义为3个独立的常量作为鉴别器,如下所示:

{
    "oneOf": [
        {
            "type": "object",
            "properties": {
                "mediaType": {
                    "const": "avatar"
                },
                "content": { "$ref": "#/definitions/avatar" }
            },
            "required": ["mediaType", "content"]
        },
        // ...
    ],
    "definitions": {
        // ...
    }
}

注意:"const"关键字仅存在于最新版本的json架构(draft6)中。您使用的验证器实现可能还没有支持它。在这种情况下,您可以使用"const": "avatar"

这样的单元素枚举替换"enum": ["avatar"]