深入浅出Json-Schema-Validation（深入浅出stm）

1

$schema

否

当前文档是否为标准JSON Schema文档，例如：

"$schema": "http://json-schema.org/draft-04/schema#"

2

$ref

否

引用其他的JSON Schema

3

id

否

id

4

title

否

标题

5

description

否

描述

6

type

是

类型，例如：object、array、string、number、integer、boolean、null、any

7

properties

-

type=object时，properties必须存在

8

patternProperties

否

正则属性，例如：

"patternProperties": {

"^test_": { "type": "string" },

}

test开头且类型为string的属性

9

additionalProperties

否

false - JSON串中只能出现Schema中定义的属性

true - JSON串中可以出现不在Schema中定义的属性

"additionalProperties": { "type": "string" } - JSON串中可以出现不在Schema中定义的属性，但类型必须string

10

required

否

必须出现的properties

11

dependencies

否

12

size

否

13

minimum

否

type=number，最小值

14

exclusiveMinimum

否

type=number，最小值，不包含minimum

15

maximum

否

type=number，最大值

16

exclusiveMaximum

否

type=number，最大值，不包含maximum

17

multipleOf

否

18

anyOf

否

满足任意一个即可，例如：

{

"anyOf": [

{ "type": "string"},

{ "type": "number"}

]

}

19

allOf

否

满足所有，例如：

{

"allOf": [

{ "type": "string" },

{ "maxLength": 5 }

]

}

20

oneOf

否

满足唯一一个，例如：

{

"type": "string",

"oneOf": [

{ "format": "host-name" },

{ "format": "ipv4" },

{ "format": "ipv6" }

]

}

21

not

否

例如：

{

"not": {

"type": "string"

}

}

22

items

-

type=array时，items必须存在

23

enum

否

枚举类型，例如：

{

"type": "string",

"enum": ["test1", "test2", "test3"]

}

属性类型为string，且只能是test1、test2、test3其中一个。

24

minItems

否

type=array，最小条目个数

25

maxItems

否

type=array，最大条目个数

26

uniqueItems

否

type=array，true - 条目不重复，反之可重复

27

minLength

否

type=string，最小字符个数

28

maxLength

否

type=string，最大字符个数

29

format

否

format规则，优先级大于type，包括：date-time、date、time、utc-millisec、regex、color、style、phone、uri、email、ip-address、ipv6、host-name、uuid、anything else（type unchanged）

30

divisibleBy

否

31

disallow

否

不包含，例如：

{

"type": "object",

"properties": {

"id": {

"disallow": "any"

},

"name": {

"type": "string",

"required": true

}

}

}

32

extends

否

继承，例如：

{

"type" : "object",

"extends" : {

"$ref" : "xxx.json"

}

}

33

default

否

默认值

34

definitions

否

复用Json Schema，例如：

{ "$ref": "#/definitions/xxx" }

{ "$ref": "definitions.json#/xxx" }

35

pattern

否

正则值，例如：

{

"type": "string",

"pattern": "^test"

}

test开头的值

{

"$schema": "http://json-schema.org/draft-04/schema#",

"title": "Test",

"type": "array",

"items": {

"type": "object",

"properties": {

"prop1": {

"description": "prop1",

"type": "integer"

},

"prop2": {

"description": "prop2",

"type": "string",

"enum": ["test1", "test2", "test3"]

},

"prop3": {

"type": "number",

"minimum": 60,

"exclusiveMinimum": true,

"maximum": 100,

"exclusiveMaximum": true

}

},

"required": ["prop1", "prop2", "prop3"]

},

minItems: 1,

maxItems: 5,

uniqueItems: true

}

Json Instance

[{

'prop1': 1,

'prop2': 'test1',

'prop3': 91

},

{

'prop1': 2,

'prop2': 'test2',

'prop3': 92

}

]