JSON Schema 介绍

如何描述 JSON ？

JSON (JavaScript Object Notation) 缩写，JSON 是一种数据格式，具有简洁、可读性高、支持广泛的特点。JSON 有以下基本数据类型

在其它语言中也有类似的内建数据类型，但是由于 JavaScript 的广泛应用，而 JSON 作为 JavaScript 原生的数据类型，具备更加广泛的支持。

有了上面列举的基本数据类型，JSON 能非常灵活的表示任意复杂的数据结构。举个例子：

  {
      "name": "George Washington",
      "birthday": "February 22, 1732",
      "address": "Mount Vernon, Virginia, United States"
  }

如何描述上面 JSON 对象呢？

首先，它是一个 object；

其次，它拥有 name、birthday、address 这三个字段

并且，name 、address 的字段值是一个字符串 String，birthday 的值是一个日期。

最后，将上面的信息如何用 JSON 来表示？如下：

  {
      "type": "object",
      "properties": {
           "name": { "type": "string" },
           "birthday": { "type": "string", "format": "date" },
           "address": { "type": "string" }
      }
  }

这个表示就是一个 JSON Schema ，JSON Schema 用于描述 JSON 数据。

相同的数据，可能有不同的表示，比如下面的两种表示，包含的信息量基本是一致的：

在特定的应用场景中，应用程序对数据的结构要求是确定的，出于对数据描述的规范化需求，需要用 JSON Schema 来规范化。使用 JSON Schema 可以描述 JSON 数据所包含的字段、以及字段值的类型，以及依赖关系等。

相同信息量的数据，采用不同的形式来表达，用 JSON Schema 来描述也是不一样的，表示二的 JSON Schema 如下：

  {
      "type": "object",
      "properties": {
           "first_name": { "type": "string" },
           "last_name": { "type": "string" },
           "birthday": { "type": "string", "format": "date-time" },
           "address": {
           "type": "object",
           "properties": {
               "street_address": { "type": "string" },
               "city": { "type": "string" },
               "state": { "type": "string" },
               "country": { "type" : "string" }
           }
          }
      }
  }

从上面的描述，可以很自然的想到 JSON Schema 可以用来做数据校验，比如前后端先把数据接口约定好，写好 JSON Schema，等后端把接口输出完毕，直接用 JSON Schema 来对接口做验收。

关于 JSON Schema 的应用，对 JSON Schema 有过了解的人可以直接跳到第三、四部分。

接下来对 JSON Schema 做一些举例说明。

JSON Schema 示例

1. 空 schema

{}

以下都是合法的 JSON

2. type 指定 JSON 数据类型

3. type 可以包含多个类型

4. string 限定长度

5. string 模式匹配

6. string 值的枚举

7. integer

integer 一定是整数类型的 number

8. multipleOf 数字倍数

9. number 限定范围

exclusiveMaximum 为 true 表示不包含边界值 maximum，类似的还有 exclusiveMinimum 字段.

10. object 不允许有额外的字段

因为包含了额外的字段 direction，而 schema 规定了不允许额外的字段 "additionalProperties": false

11. object 允许有额外的字段，并限定类型

12. object 必填字段

多出字段也是 ok 的

少了字段，就是不行

13. object 指定属性个数

14. Dependencies 依赖

15. Object 属性的模式匹配

16. array 数组

17. array 指定数组成员类型

18. array 指定数组成员类型，逐个指定

19. array 指定数组成员类型，逐个指定，严格限定

20. array 数组长度限制

21. array element uniqueness 数组元素的唯一性

22. boolean

23. null

24. schema 的合并

string 类型，最大长度为 5 ；或 number 类型，最小值为 0

25. allOf、oneOf

26. oneOf

上面的 schema 也可以写为：

27. not

只要是非 string 类型即可

如何描述 JSON ？#

JSON Schema 示例#

1. 空 schema#

2. type 指定 JSON 数据类型#

3. type 可以包含多个类型#

4. string 限定长度#

5. string 模式匹配#

6. string 值的枚举#

7. integer#

8. multipleOf 数字倍数#

9. number 限定范围#

10. object 不允许有额外的字段#

11. object 允许有额外的字段，并限定类型#

12. object 必填字段#

13. object 指定属性个数#

14. Dependencies 依赖#

15. Object 属性的模式匹配#

16. array 数组#

17. array 指定数组成员类型#

18. array 指定数组成员类型，逐个指定#

19. array 指定数组成员类型，逐个指定，严格限定#

20. array 数组长度限制#

21. array element uniqueness 数组元素的唯一性#

22. boolean#

23. null#

24. schema 的合并#

25. allOf、oneOf#

26. oneOf#

27. not#