json schema文档

最新推荐文章于 2024-09-15 07:55:10 发布

梦殇918

最新推荐文章于 2024-09-15 07:55:10 发布

阅读量1k

点赞数

分类专栏： ECMAScript 文章标签： json

本文链接：https://blog.csdn.net/mengshang529/article/details/106059452

版权

ECMAScript 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

类型

type

Number/string/boolean/object/array/null
字符串、字符串数组形式

string
- minLength 非负数
- maxLength 非负数
- pattern 正则‘
- format常用格式
  - 日期
  - 邮件
  - 主机名
  - ip
  - uri
  - 正则表达式
  - …
number/integer(整数)
- multipleOf 倍数
- X ≥minimum
- x >exclusiveMinimum
- X ≤maximum
- x <exclusiveMaximum

object键值必须是字符串

properties 对象属性
additionalProperties 是否允许有额外属性
required 必填的属性字符串数组
propertyNames 键值名称
- pattern 正则匹配键值名称是否符合
minProperties 属性最小数量非负整数
maxProperties 属性最大数量非负整数

patternProperties 给定的属性名符合正则

{
  "type": "object",
  "patternProperties": {
    "^S_": { "type": "string" },
    "^I_": { "type": "integer" }
  },
  "additionalProperties": false
}

dependencies 依赖

属性依赖

{
	"type":"object",
	"properties":{
		"name":{
			"type":"string",
			"age":"number"
		}
	},
	 "dependencies":{
	 		"name":["age"]
	 }
}
//有name时，必须有age

schema 依赖

{
	"type":"object",
	"properties":{
		"name":{
			"type":"string",
			"age":"number"
		}
	},
	 "dependencies":{
	 		"name":{
        "properties":{
          "address":{
            "type":"string"
          },
          required:["address"]
        }	
	 		}
	 }
}
//有name的时候，必须有string类型的address

array

Items 验证数组每个元素

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

contains 验证数组中某个元素符合条件
items是数组，单独验证每个元素是否符合相应条件

additionalItems 附加项验证

{
  "type": "array",
  "items": [
    {
      "type": "number"
    },
    {
      "type": "string",
      "enum": ["Street", "Avenue", "Boulevard"]
    }
  ],
  "additionalItems":{"type":"string"}
}
//数组第一个元素是number，第二个元素是“street”/"avenue"/"boulevard"中的一个,后续元素都是string

minItems 最少
maxItems 最大
uniqueItems 数组中每个元素都是唯一的

boolean

必须严格相等===
null

严格相等===

关键字

不会校验的关键字

title

string
description

string
default

默认值
examples

例子
$comment严格注释：将注释留给JSON模式的未来编辑者

会校验的关键字

enum

const作为enum 1个时的语法糖

{ "const": "United States of America" }
//等价于
{ "enum": [ "United States of America" ] }

非json格式的数据校验

contentMediaType 数据类型图片、文档类型…

参考：
- https://www.iana.org/assignments/media-types/media-types.xhtml
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
contentEncoding 编码类型

可接受的值为7bit，8bit，binary，quoted-printable 和base64。如果未指定，则编码与包含的JSON文档相同UTF-8。

组合模式

allOf：所有的都符合
anyOf：符合一个或者多个
oneOf：只有一个符合，多个符合会失败
not 不满足
```
{ "not": { "type": "string" } }
```

条件

if/then/else

假设您要编写一个模式来处理美国和加拿大的地址。这些国家/地区的邮政编码格式不同，我们希望根据国家/地区选择要验证的格式。如果地址在美国，则该postal_code字段为“邮政编码”：五位数字，后跟可选的四位后缀。如果地址在加拿大，则该postal_code字段为六位字母数字字符串，字母和数字交替出现。

{
  "type": "object",
  "properties": {
    "street_address": {
      "type": "string"
    },
    "country": {
      "enum": ["United States of America", "Canada"]
    }
  },
  "if": {
    "properties": { "country": { "const": "United States of America" } }
  },
  "then": {
    "properties": { "postal_code": { "pattern": "[0-9]{5}(-[0-9]{4})?" } }
  },
  "else": {
    "properties": { "postal_code": { "pattern": "[A-Z][0-9][A-Z] [0-9][A-Z][0-9]" } }
  }
}

可以配合allof实现多个的场景

高级

$schema

指定当前schema使用的规范
$id
- 它为模式声明了唯一的标识符。
- 它声明了一个基础URI，可以根据该基础URI $ref引用进行解析。

$ref

可以配合definition实现重用

当某几个属性具有相同的格式时，可以在父schema的定义一个definition并配合$ref实现重用

当前文件#

{ "$ref": "#/definitions/address" }
当前json相同URI的json文件

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

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

  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      },
      "required": ["street_address", "city", "state"]
    }
  },

  "type": "object",

  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": { "$ref": "#/definitions/address" }
  }
}

实现递归，调用自身

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

  "definitions": {
    "person": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "children": {
          "type": "array",
          "items": { "$ref": "#/definitions/person" },
          "default": []
        }
      }
    }
  },

  "type": "object",

  "properties": {
    "person": { "$ref": "#/definitions/person" }
  }
}

配合$id使用，无需依照位置

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

  "definitions": {
    "address": {
      "$id": "#address",
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      },
      "required": ["street_address", "city", "state"]
    }
  },

  "type": "object",

  "properties": {
    "billing_address": { "$ref": "#address" },
    "shipping_address": { "$ref": "#address" }
  }
}

配合条件 allOf、anyOf、oneOf

使用ajv、ajv-keywords、ajv-errors校验

const Ajv = require('ajv')
const ajv = new Ajv({ allErrors: true, jsonPointers: true, $data: true });
require('ajv-errors')(ajv)
require('ajv-keywords')(ajv);

//json schema
const schema = {}
//待校验数据
const data = {}

//方法一
const validate = ajv.compile(schema)
console.log(validate(data)) //返回boolean，是否校验通过
console.log(validate.error) //校验的错误对象

//方法二
const bol = ajv.validate(schema,data)