使用JSON模式验证JSON输入

时间:2015-05-07 14:54:31

标签: json validation schema jsonschema json-schema-validator

如果在输入文件中指定在架构中配置为要求的元素,则验证确定。 如果你附加“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"]
}

INPUTFILE:

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

这不应该是无效的输入文件吗?

验证人:

1 个答案:

答案 0 :(得分:5)

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

混淆的部分是你希望数组是对象和对象是数组,有时很难区分。

用非常简单的术语表示:
JSON对象键:值对的。就好像你要定义一个对象(类)并用OOP语言设置它的属性值。
JSON对象的基本定义

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

JSON数组集合,具有相同的,有时相似的对象或单个值。
JSON数组的基本定义

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

什么也可以帮助定义什么时候使用,是考虑你想要创建什么,但作为OOP语言中的对象。

示例:

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

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)

班级代表:

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的数组/集合。如果我们想将它添加到JSON模式和类中,我们将需要将其定义为这样。在我们处理它的同时,让我们为Keywords每本书添加一个字符串数组,这样就很清楚如何定义它们。

首先让我们改变我们想要的输出( JSON ) 我们希望基础对象现在为Books,它应该是Book对象的集合,因此我们将Book 对象包含在内[ ]中,为了它的另一本书。我们还向对象Keywords添加了Book的集合。

{
  "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的类/对象表示,这样做有助于了解如何修改模式。

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; }
}

我们现在知道当我们最终解析JSON时,我们的数据会是什么样子。让我们更改 JSON Schema ,以便我们可以在验证器中使用。

{
  "$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"]
      }
    }
  }
}

我在数组定义中添加了一些minItemsmaxItems,以便您可以查看设置它们的位置和方式。您可以将架构和数据复制到任何验证器,并使用它们来查看它们的工作方式。

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

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


将JSON转储到任何提到的验证器中,它们都将验证为正确传递。我检查了JSON Schema Google Group确认当前无法通过架构定义检查它。

处理重复属性的方式也是特定于库的 例如,C#的Newtonsoft.JsonServiceStack库都将使用最后一次出现的属性 因此,从我们的示例中,使用任一库反序列化后Book.Author属性的值将是&#34; !! Duplicate Author !!&#34;。

一些消息来源: