JSON&JSON-Schema

相关资料

JSON

www.json.org

https://www.json.org/json-zh.html

www.ecma-international.org

https://www.ecma-international.org/wp-content/uploads/ECMA-404_1st_edition_october_2013.pdf

JSON Schema

JSON Schema is a vocabulary that allows you to annotate and validate JSON documents. Describes your existing data format(s). Provides clear human- and machine- readable documentation. Validates data which is useful for: Automated testing. Ensuring quality of client submitted data. Learning a new specification can be daunting.

https://json-schema.org/

JSON Schema 校验

JSON Schema Validator - Newtonsoft

An online, interactive JSON Schema validator

https://www.jsonschemavalidator.net/

JSON Schema 生成

JSON Schema Generator

JSON Schema Generator - automatically generate JSON schema from JSON.

https://jsonschema.net/home

JSON

简介

语法

• 数据使用名/值对表示

• 使用大括号保存对象，每个名称后面跟着一个 ':'（冒号），名/值对使用 ,（逗号）分割。

• 使用方括号保存数组，数组值使用 ,（逗号）分割。

数据结构

• object（对象）

{
	"a" : {
		"b": "c"
	}
}

• array （数组）

21{
	"a": [1, 2, 3]
}

• string (字符串)

{
	"a": "a"
}

• number (整数 | 浮点数)：

{
	"a": 1
}

• boolean（true | false）

{
	"a": true
}

• null

{
	"a": null
}

 

JSONSchema

Understanding JSON Schema - Understanding JSON Schema 7.0 documentation

JSON Schema is a powerful tool for validating the structure of JSON data. However, learning to use it by reading its specification is like learning to drive a car by looking at its blueprints. You don't need to know how an electric motor fits together if all you want to do is pick up the groceries.

https://json-schema.org/understanding-json-schema/index.html

简介

关键字

$schema

{
	"$schema": "http://json-schema.org/draft/2019-09/schema"
}

Specification

The current version is 2020-12! The previous version was 2019-09. See also the release notes / change log (Work in progress). The specification is split into two parts, Core and Validation. We also publish the Relative JSON Pointers spec although it's not currently used by Core or Validation in any significant way.

https://json-schema.org/specification.html

• https://json-schema.org/draft/2020-12/schema

• https://json-schema.org/draft/2019-09/schema

• https://json-schema.org/draft-07/schema

• https://json-schema.org/draft-06/schema

• https://json-schema.org/draft-04/schema

$id

• 当前schema唯一id标识

• 它声明一个基础URI，可以根据该基础URI $ref 引用进行解析

• 该$id属性绝不能为空字符串或空片段（#），因为这实际上没有任何意义。

{
	"$id": "http://example.com/example.json"
}

title

description

default

examples

type

{ "type": "number" }

{
	"type": ["string", "number"]
}

pattern

Regular Expressions - Understanding JSON Schema 7.0 documentation

https://json-schema.org/understanding-json-schema/reference/regular_expressions.html

enum

{
  "type": "string",
  "enum": ["red", "amber", "green", null]
}

const

{
  "properties": {
    "country": {
      "const": "United States of America"
    }
  }
}

{ "const": "United States of America" }

{ "enum": [ "United States of America" ] }

Applying subschemas conditionally

Combining schemas

complex schema

contentMediaType

{
  "type": "string",
  "contentMediaType": "text/html"
}

contentEncoding

• 7bi

• 8bit

• binary

• quoted-printable

• base64

{
  "type": "string",
  "contentEncoding": "base64",
  "contentMediaType": "image/png"
}

$comment