Question

我有一个示例json：

{
    "type": "persons",
    "id": 2,
    "attributes": {
        "first": "something",
        "second": "something else"
    }
}

我必须为其制作架构（使用JSON API specs和JSON schema docs）：

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "type": {
            "type": "string",
            "pattern": "^persons$"
        },
        "id": {
            "type": "integer"
        },
        "attributes": {
            "type": "object",
            "properties": {...}
        }
    },
    "required": ["type", "id", "attributes"]
}

问题是：如果“类型”唯一可接受的值是“人”，我应该使用模式模式（如上所述）还是枚举类似

"enum": ["persons"]

我无法从文档中得到任何明确的答案，尽管在规范枚举中的示例用于单个值。你有什么看法？

Answer 1

最终，它并不重要。两者都有效，两者都合理。也就是说，我见过的最常见的方法是使用enum。两者都不是完美的可读性，但我认为enum更好有两个原因。

使用pattern需要两行表达。使用enum只需要一个，因为数组中的值隐含了type。两条线比一条线更难阅读，所以如果那条线足够表达，我说坚持一条线。
并非所有人都习惯阅读正则表达式。由于这个原因，enum可能更容易访问。

Answer 2

自draft-6以来，这个用例有一个名为const的新关键字。

"type": {
        "type": "string",
        "const": "persons"
},

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.3

JSON模式枚举与单值的模式

2 个答案: