json-schema数组上需要的设置

Question

我正在尝试弄清楚如何在我的json-Schema对象数组上设置必需属性在对象上正常工作，而不是数组。

以下是我的json模式的项目部分：

        "items": {
        "type": "array",
        "properties": {
            "item_id": {"type" : "number"},
            "quantity": {"type": "number"},
            "price": {"type" : "decimal"},
            "title": {"type": "string"},
            "description": {"type": "string"}
        },
        "required": ["item_id","quantity","price","title","description"],
        "additionalProperties" : false
    }

这是我发送的 json 数组。json验证应该会失败，因为我没有在这些项目中传递描述。

       "items": [
        {
            "item_id": 1,
            "quantity": 3,
            "price": 30,
            "title": "item1 new name"
        },
        {
            "item_id": 1,
            "quantity": 16,
            "price": 30,
            "title": "Test Two"
        }
    ]

Answer 1

也许您的验证程序仅支持 JSONSchema v3？

所需工作方式在 v3 和 v4 之间发生了变化：

• 在v3中必需是一个布尔值：https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-03#section-5.7
• 在v4中必需是一个字符串数组（就像在您的示例中一样）：https://datatracker.ietf.org/doc/html/draft-fge-json-schema-validation-00#section-5.4.3

Answer 2

我知道这是一个古老的话题，但是因为这个问题是从jsonschema.net链接起来的，我想它可能值得插一脚…

您的原始示例的问题是，您为“数组”类型声明“属性”，而不是为数组声明“项”，然后声明填充数组的“对象”类型(带有“属性”)。下面是原始模式片段的修订版:

"items": {
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "item_id": {"type" : "number"},
            "quantity": {"type": "number"},
            "price": {"type" : "decimal"},
            "title": {"type": "string"},
            "description": {"type": "string"}
        },
        "required": ["item_id","quantity","price","title","description"],
        "additionalProperties" : false
    }
}

我建议不要使用术语“items”作为数组的名称，以避免混淆，但是没有什么可以阻止你这样做......

Answer 3

我通过将数组元素的架构部分嵌套在名为item的对象中来使用这个验证器。该模式现在有两个嵌套的项目字段，但这是因为一个是JSONSchema中的关键字，另一个是因为您的JSON实际上有一个名为项目的字段

JSONSchema：

{
   "type":"object",
   "properties":{
      "items":{
         "type":"array",
         "items":{
            "properties":{
               "item_id":{
                  "type":"number"
               },
               "quantity":{
                  "type":"number"
               },
               "price":{
                  "type":"number"
               },
               "title":{
                  "type":"string"
               },
               "description":{
                  "type":"string"
               }
            },
            "required":[
               "item_id",
               "quantity",
               "price",
               "title",
               "description"
            ],
            "additionalProperties":false
         }
      }
   }
}

JSON：

{
   "items":[
      {
         "item_id":1,
         "quantity":3,
         "price":30,
         "title":"item1 new name"
      },
      {
         "item_id":1,
         "quantity":16,
         "price":30,
         "title":"Test Two"
      }
   ]
}

输出中包含两个关于缺少描述字段的错误：

[ {
  "level" : "error",
  "schema" : {
    "loadingURI" : "#",
    "pointer" : "/properties/items/items"
  },
  "instance" : {
    "pointer" : "/items/0"
  },
  "domain" : "validation",
  "keyword" : "required",
  "message" : "missing required property(ies)",
  "required" : [ "description", "item_id", "price", "quantity", "title" ],
  "missing" : [ "description" ]
}, {
  "level" : "error",
  "schema" : {
    "loadingURI" : "#",
    "pointer" : "/properties/items/items"
  },
  "instance" : {
    "pointer" : "/items/1"
  },
  "domain" : "validation",
  "keyword" : "required",
  "message" : "missing required property(ies)",
  "required" : [ "description", "item_id", "price", "quantity", "title" ],
  "missing" : [ "description" ]
} ]

尝试将上面的内容粘贴到这里，查看生成的相同输出。