使用 JSON 模式验证 JSON 输入

Question

如果您在输入文件中指定配置为模式要求的元素，则验证正常。如果你追加“maxItems”：1，它不关心你是否在输入文件中添加另一个元素，验证器仍然将其视为一个有效的输入文件。

即：架构：

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "Books": {
            "type": "object",
            "minItems": 1,
            "properties": {
                "Book": {
                    "type": "object",
                    "minItems": 1,
                    "maxItems": 1,
                    "properties": {
                        "Author": {
                            "type": "string",
                            "minItems": 1,
                            "maxItems": 1
                        }
                    },
                    "required": ["Author"]
                }
            },
            "required": ["Book"]
        }
    },
    "required": ["Books"]
}

输入文件：

{
    "Books": {
        "Book": {
            "Author": "Andreas",
            "Author": "Geir"
        }
    }
}

这不应该是一个无效的输入文件吗？

验证者：

Answer 1

根据您定义的架构，给定的 JSON 是正确的。你的模式说的是，对于每个对象 Author，应该有最少 1 个和最多 1 个字符串属性，你的 JSON 符合。
除此之外，属性 minItems 和 maxItems 专门用于 arrays，但在您的定义中，它们在 objects 下。在底部的链接文档中阅读更多相关信息。

造成混淆的部分是您期望数组是对象，而对象是数组，这有时很难区分。

简单来说：
JSON object 是 set 的 key:value 对。这就好像您正在定义一个对象 (class) 并用 OOP 语言设置它的属性值。
JSON对象的基本定义:

{
  "type": "object",
  "properties": {
    "MyString": {
      "type": "string"
    },
    "MyInterger": {
      "type": "integer"
    }
}

一个JSON数组是一个集合相同的，有时相似的对象或单个值。
JSON数组的基本定义:

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

还有什么可以帮助定义什么时候使用什么，就是想想你想要创建什么，但是作为 OOP 语言中的对象。

示例：

对于下面的 Book JSON 对象 ，我可以想象一个如图所示的 class 结构，然后从中创建模式:

JSON:

{
  "Author": "First Author",
  "TotalPages": 128,
  "Chapters": [
    {
      "Number": 1,
      "Heading": "Chapter One"
    },
    {
      "Number": 2,
      "Heading": "Chapter Two"
    }
  ]
}

我们拥有的是

两个基本对象Author (string)和TotalPages (integer)
Chapters对象的数组，包含两个基本对象Number (integer)和Heading (string)

Class表示：

public class Book
{
  public string Author { get; set; }
  public int TotalPages { get; set; }
  // Note the array
  public Chapter[] Chapters { get; set; } // Could be List<Chapter>
}

public class Chapter
{
  public int Number { get; set; }
  public string Heading { get; set; }
}

生成的架构：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Author": {
      "type": "string"
    },
    "TotalPages": {
      "type": "integer"
    },
    "Chapters": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "Number": {
            "type": "integer"
          },
          "Heading": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": ["Author", "Chapters"]
}

现在您会注意到我故意省略了 `Books` 部分，因为那是 `Book` 的 *an array/collection*。如果我们想将其添加到 JSON 模式和 class，我们将需要这样定义它。在我们这样做的同时，让我们还为每本书添加一个字符串数组，用于“关键字”，以便清楚如何定义每个关键字。

首先让我们改变我们想要的输出（JSON）。
我们希望我们的 基础对象 现在是 Books 并且它应该是 Book 对象的集合，所以我们包含 Book object in [ ] 并添加另一本书。我们还向对象 Book.

添加了一个 Keywords 的集合

{
  "Books":
  [
    {
      "Author": "First Author",
      "TotalPages": 128,
      "Chapters": [
        {
          "Number": 1,
          "Heading": "Chapter One"
        },
        {
          "Number": 2,
          "Heading": "Chapter Two"
        }
      ],
      "Keywords": [
        "This",
        "is",
        "book",
        "Alpha"
      ]
    },
    {
      "Author": "Second Author",
      "TotalPages": 256,
      "Chapters": [
        {
          "Number": 1,
          "Heading": "Erstes Kapitel"
        },
        {
          "Number": 2,
          "Heading": "Zweites Kapitel"
        }
      ],
      "Keywords": [
        "This",
        "is just",
        "Beta"
      ]
    }
  ]
}

现在我们有以下内容：

一个对象 Books，它包含我们之前定义的 Book 对象的数组。（请注意，Book 从未被命名，因为这会在 JSON 中添加另一层层次结构）
除了我们之前定义的对象，我们还有一个string的数组代表Keywords

让我们更改 JSON 的 class/object 表示，这样做将有助于了解如何修改架构。

public class MyBookCollection
{
  // Note the array!!
  public Book[] Books { get; set; } // Could also be List<Book>
}

public class Book
{
  public string Author { get; set; }
  public int TotalPages { get; set; }
  // Note the arrays!!
  public Chapter[] Chapters { get; set; } // Could also be List<Chapter>
  public string[] Keywords { get; set; }  // Could also be List<string>
}

public class Chapter
{
  public int Number { get; set; }
  public string Heading { get; set; }
}

我们现在知道我们的数据和class最终解析JSON.让我们更改 JSON 模式 以便我们可以在验证器中使用一些东西。

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Books": {
      "type": "array",
      "minItems": 1,
      "maxItems": 15,
      "title": "Book",
      "items": {
        "type": "object",
        "properties": {
          "Author": {
            "type": "string"
          },
          "TotalPages": {
            "type": "integer"
          },
          "Chapters": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "object",
              "properties": {
                "Number": {
                  "type": "integer"
                },
                "Heading": {
                  "type": "string"
                }
              }
            }
          },
          "Keywords": {
            "type": "array",
            "minItems":2,
            "items": {
              "type": "string"
            }
          }
        },
        "required": ["Author", "Chapters"]
      }
    }
  }
}

我在 数组定义 中添加了一些 minItems and maxItems 以便您可以看到设置它们的位置和方式。您可以将架构和数据复制到任何验证器并试用它们以了解它们的工作原理。

另外一件重要的事情：
您无法通过架构验证来防止或检查对象内的重复属性。
例如，使用我们简单的 JSON 对象并添加一个重复的属性,

{
  "Author": "First Author",
  "Author": "!!Duplicate Author!!",
  "TotalPages": 128,
  "Chapters": [
    {
      "Number": 1,
      "Heading": "Chapter One"
    },
    {
      "Number": 2,
      "Heading": "Chapter Two"
    }
  ]
}

将 JSON 转储到任何提到的验证器中，它们都将验证为 **正确** 和 **通过**。我检查并在 [JSON 架构 Google 组][6] 上确认，目前无法通过架构定义检查它。

如何处理重复属性也是库特定的。
例如，C# 的 Newtonsoft.Json and ServiceStack 库都将使用最后一次出现的属性.
因此，根据我们的示例，使用任一库反序列化后 Book.Author 属性的值将是“!!Duplicate Author!!”。

一些来源：

The latest version of the JSON Schema definition
The GitHub repo of all the versions of the definitions
Another question about array vs object

使用 JSON 模式验证 JSON 输入

Validating JSON input with a JSON schema

json

validation

schema

jsonschema

json-schema-validator