jsonschema 简介

最新推荐文章于 2024-04-28 09:39:35 发布
最新推荐文章于 2024-04-28 09:39:35 发布
阅读量298 收藏 1
点赞数
分类专栏： Json 文章标签： json python
原文链接：https://www.cnblogs.com/ChangAn223/p/11234348.html
版权

转载地址：
https://www.cnblogs.com/terencezhou/p/10474617.html
https://www.cnblogs.com/ChangAn223/p/11234348.html

官方网址：
https://json-schema.org/understanding-json-schema/reference/conditionals.html

文章目录

jsonschema 简介

假设现有 web api 请求参数为 json数据，例：

{
    "name" : "lisi", 
    "age": 20, 
    "appearance" : {
        "high":180.0, 
        "weight":140.0
        }
}

以上例子 json数据包含 name、age、appearance等参数，为此Json Schema定义一套定义 json数据格式的规则，在api请求时对json 参数进行验证（ Json Schema Validator）

{ 
    "type": "object",
    "properties": {
        "name": { "type": "string" },
        "age": { "type": "integer" },
        "appearance": { 
            "type": "object",
            "properties": {
                "high" : {"type": "number"},
                "weight" : {"type": "number"}
            }                       
        }
    }
}

2. 类型关键字

关键字type

Python和 Json数据类型对应关系：

Python数据类型Json数据类型Json 值
dictobject{“name”:“li”, “age”: 14, “high”: 12.2, “other”: {…}}
listarrary[“a”, 1, 1.2, [“b”], ,{“n”:“lisi”} ]
strstring“hello world”
int/floatnumber1.2 | 2
intinteger2
bool（True/False）booleantrue | false
None（None）nullnull

3. 简单类型

3.1 string

Json合法的字符串

"Today is a good day."

对应的Json Schema

{"type": "string"}

可以进一步对字符串做规范要求。字符串长度、匹配正则表达式、字符串格式。

3.1.1 字符串长度

关键字： minLength, maxLength

可以对字符串的最小长度、最大长度做规范。

{
    "type" : "string",
    "minLength" : 2,
    "maxLength" : 3,
}

3.1.2 正则表达式

关键字： pattern

可以对字符串应满足的Pattern做规范，Pattern通过正则表达式描述。

{
    "type" : "string",
    "pattern" : "^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$",
}

3.1.3 字符串Format

关键字： format

可以通过Json Schema内建的一些类型，对字符串的格式做规范，例如电子邮件、日期、域名等。
{ "type" : "string", "format" : "date", }

Json Schema支持的format包括"date", “time”, “date-time”, “email”, "hostname"等。具体可以参考文档。

3.2 number/integer

数字（小数，负数等）和整数

3.2.1 数值满足倍数

关键字： multipleOf

可以要求数值必须某个特定值的整数倍。例如要求数值必须是10的整数倍。

{
    "type" : "number",
    "multipleOf" : 10,
}

3.2.2 数值范围

关键字： minimum, maximum, exclusiveMinimum, exclusiveMaximum

可以限制数值的方位，包括最大值、最小值、开区间最大值、开区间最小值。

要求数值在[0, 100)范围内。

{
    "type" : "number",
    "minimum": 0,
    "exclusiveMaximum": 100
}

3.3 boolean

布尔类型没有额外的类型特定参数。

3.4 null

null类型没有额外的类型特定参数。

4. 复合类型

复合类型可以通过Nest的方式构建复杂的数据结构。包括数组、对象。

4.1 array

Json数组合法数据的例子

[1, 2, 3]
[1, "abc", {"name" : "alex"}]`
[]

Json Schema为

{"type": "array"}

数组的类型特定参数，可以用来限制成员类型、是否允许额外成员、最小元素个数、最大元素个数、是否允许元素重复。

4.1.1 数组成员类型

关键字： items

可以要求数组内每个成员都是某种类型，通过关键字items实现。下面的Schema要求数组内所有元素都是数值，这时关键字"items"对应一个嵌套的Json Schema，这个Json Schema定义了每个元素应该满足的规范。

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

[1, 2, 3]

关键字items还可以对应一个数组，这时Json数组内的元素必须与Json Schema内items数组内的每个Schema按位置一 一匹配。

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

请注意：数组内只有一个Json Schema时，对于 items
 [ { "type": "number"}, ] 等价于  "items": { "type": "number"}


[1, "abc"]

4.1.2 数组是否允许额外成员

关键字： additionalItems

当使用了items关键字，并且items关键字对应的是Schema数组，这个限制才起作用。关键字additionalItems规定Json数组内的元素，除了一一匹配items数组内的Schema外，是否还允许多余的元组。当additionalItems为true时，允许额外元素。

{
    "type": "array",
    "items": [
    {
        "type": "number"
    },
    {
        "type": "string"
    }],
    "additionalItems" : true / false
    `# 允许出现类型是string的额外成员`
    #"additionalItems": { "type": "string" },
    #"additionalItems": { oneOf: [jsonschema1, jsonschema2..] },
}

[1, "abc", "x"]

4.1.3 数组元素个数

关键字： minItems, maxItems

可以限制数组内元素的个数, 默认情况下：minItems=0， maxItems=无限制

{
    "type": "array",
    "items": {
        "type": "number"
    },
    "minItems" : 5,
    "maxItems" : 10
}

[1,2,3,4,5,6]

4.1.4 数组内元素是否必须唯一

关键字： uniqueItems

规定数组内的元素是否必须唯一。

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

[1,2,3,4,5]

4.2 object

Json对象是最常见的Json数据类型，合法的数据可以是

{
    "name": "Froid",
    "age" : 26,
    "address" : {
        "city" : "New York",
        "country" : "USA"
    }
}

就对象类型而言，最基本的类型限制Schema是

{"type" : "object"}

然而，除了类型外，我们通常需要对其成员做进一步约定。对象的类型特定关键字，大多是为此目的服务的。

4.2.1 成员

关键字：properties

规定对象各成原所应遵循的Schema。

{ 
    "type": "object",     
    "properties": {      
        "name": {"type" : "string"},
        "age" : {"type" : "integer"},
        "address" : {
            "type" : "object",
            "properties" : {
                "city" : {"type" : "string"},
                "country" : {"type" : "string"}
            }
        }
    }
}

对于上例中的Schema，合法的data是

{
    "name": "Froid",
    "age" : 26,
    "address" : {
        "city" : "New York",
        "country" : "USA"
    }
}

properties关键字的内容是一个key/value结构的字典，其key对应Json数据中的key，其value是一个嵌套的Json Schema。表示Json数据中key对应的值所应遵守的Json Schema。在上面的例子中，"name"对应的Schema是{"type" : "string"}，表示"name"的值必须是一个字符串。在Json数据中，对象可以嵌套，同样在Json Schema中也可以嵌套。如"address"字段，在Json Schema中它的内容是一个嵌套的object类型的Json Schema。

4.2.2 批量定义成员Schema

关键字：patternProperties

与properties一样，但是key通过正则表达式匹配属性名。

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

{"S_1" : "abc"}`
`{"S_1" : "abc", "I_3" : 1}

4.2.3 必须出现的成员

关键字：required

规定哪些对象成员是必须的。

{ 
    "type": "object",     
    "properties": {      
        "name": {"type" : "string"},
        "age" : {"type" : "integer"},
    },
    "required" : ["name"]
}

上例中"name"成员是必须的，因此合法的数据可以是

{"name" : "mary", "age" : 26}`
`{"name" ： "mary"}

但缺少"name"则是非法的

{"age" : 26}

4.2.4 成员依赖关系

关键字：dependencies

规定某些成员的依赖成员，不能在依赖成员缺席的情况下单独出现，属于数据完整性方面的约束。

{
    "type": "object",
    "dependencies": {
        "credit_card": ["billing_address"]
    }
}

dependencies也是一个字典结构，key是Json数据的属性名，value是一个数组，数组内也是Json数据的属性名，表示key必须依赖的其他属性。

上面Json Schema合法的数据可以是

{}
{"billing_address" : "abc"}

但如果有"credit_card"属性，则"billing_address" 属性不能缺席。下面的数据是非法的

{"credit_card": "7389301761239089"}

4.2.5 是否允许额外成员

关键字：additionaProperties

规定object类型是否允许出现不在properties中规定的属性，只能取true/false。

{ 
    "type": "object",     
    "properties": {      
        "name": {"type" : "string"},
        "age" : {"type" : "integer"},
    },
    "required" : ["name"],
    "additionalProperties" : false
    `# 允许出现类型是string的额外成员`
    #"additionalProperties": { "type": "string" },
    #"additionalProperties": { oneOF: [jsonschema1, jsonschema2..] },
}

上例中规定对象不能有"name"和"age"之外的成员。
(允许出现类型是string的额外成员)
合法的数据

{"name" : "mary"}`
`{"name" : "mary", "age" : 26}

非法的数据

{"name" : "mary", "phone" : "84893948"}

4.2.6 属性个数的限制

关键字：minProperties, maxProperties

规定最少、最多有几个属性成员。

{
    "type": "object",
    "minProperties": 2,
    "maxProperties": 3
}

{"name" : "mary", "age" : 26}
{"name" : "mary", "age" : 26, "phone" : "37839233"}

5. 逻辑组合

关键字：allOf, anyOf, oneOf, not

从关键字名字可以看出其含义，满足所有、满足任意、满足一个。前三个关键字的使用形式是一致的，以allOf为例说明其形式。

{
    "allOf" : [
        Schema1,
        Schema2,
        ...
    ]
}

其中，"allOf"的内容是一个数组，数组内的成员都是内嵌的Json Schema。上例Schema1、Schema2都是内嵌的Json Schema。整个Schema表示当前Json数据，需要同时满足Schema1、Schema2,。

5.1 allOf

满足所有 Json Schema，数组不能为空

{
    "allOf" : [
        Schema1,
        Schema2,
        ...
    ]
}

需要注意，不论在内嵌的Schema里还是外部的Schema里，都不应该使"additionalProperties"为false。否则可能会生成任何数据都无法满足的矛盾Schema。

可以用来实现类似“继承”的关系，例如我们定义了一个Schema_base，如果想要对其进行进一步修饰，可以这样来实现。

{
    "allOf" : [
        Schema_base
    ],
    "properties" : {
        "other_pro1" : {"type" : "string"},
        "other_pro2" : {"type" : "string"}
    },
    "required" : ["other_pro1", "other_pro2"]
}

Json数据既需要满足Schema_base，又要具备属性"other_pro1"、“other_pro2”。

5.2 anyOf

满足任意一个 Schema。

{
    "anyOf" : [
        Schema1,
        Schema2,
        ...
    ]
}

Json数据需要满足Schema1、Schema2中的一个或多个。

5.3 oneOf

仅满足其中一个 Schema，这也是与anyOf的区别。

{
    "oneOf" : [
        Schema1,
        Schema2,
        ...
    ]
}

5.4 not

这个关键字不严格规定Json数据应满足什么要求，它告诉Json不能满足not所对应的Schema。

{
    "not" : {"type" : "string"}
}

只要不是string类型的都Json数据都可以。

5.5 if-then-else

关键字 ：if then else

草案版本： @since draft-07

详解if-then-else

{
  "type": "object",
  "properties": {
    "country": {"enum": ["USA", "Canada"] }
  },
  "if": {
    "properties": { "country": { "const": "USA" } }
  },
  "then": {
    "properties": { "code": { "const": "USA CODE" } }
  },
  "else": {
    "properties": { "code": { "const": "Canada CODE" } }
  }
}

{
    "country": "USA",
    "code": "USA CODE"
}
------------------#√
{
    "country": "USA",
    "code": "Canada CODE"
}
------------------#X

{
  "type": "object",
  "properties": {
    "country": {"enum": ["USA", "Canada", "Netherlands"]}
  },
  "allOf": [
    {
      "if": {
        "properties": { "country": { "const": "USA" } }
      },
      "then": {
        "properties": { "code": { "const": "USA code" } }
      }
    },
    {
      "if": {
        "properties": { "country": { "const": "Canada" } }
      },
      "then": {
        "properties": { "code": { "const": "Canada code" } }
      }
    },
    {
      "if": {
        "properties": { "country": { "const": "Netherlands" } }
      },
      "then": {
        "properties": { "code": { "const": "Netherlands code" } }
      }
    }
  ]
}
-------------------
{
    "country": "USA",
    "code": "USA CODE"
}
------------------#√

6. 复杂结构

对复杂结构的支持包括定义和引用。可以将相同的结构定义成一个“类型”，需要使用该“类型”时，可以通过其路径或id来引用。

6.1 定义

关键字：无

定义一个类型，并不需要特殊的关键字。通常的习惯是在root节点的definations下面，定义需要多次引用的schema。definations是一个json对象，key是想要定义的“类型”的名称，value是一个json 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" }
    }
}

上例中定义了一个address的schema，并且在两个地方引用了它，#/definitions/address表示从根节点开始的路径。

6.2 id>∗∗关键字：id>∗∗关键字：id**

可以在上面的定义中加入id属性，这样可以通过id属性，这样可以通过id属性的值对该schema进行引用，而不需要完整的路径。

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

6.3 引用

关键字：$ref

关键字$ref可以用在任何需要使用json schema的地方。如上例中，billing_address的value应该是一个json schema，通过一个$ref替代了。

$ref的value，是该schema的定义在json中的路径，以#开头代表根节点。

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

如果schema定义了$id属性，也可以通过该属性的值进行引用。

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

7. 通用关键字

通用关键字可以在任何json schema中出现，有些影响合法性校验，有些只是描述作用，不影响合法性校验。

7.1 enum-枚举

关键字：enum

可以在任何json schema中出现，其value是一个list，表示json数据的取值只能是list中的某个。

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

上例的schema规定数据只能是一个string，且只能是"red"、“amber”、"green"之一。

7.2 const-常量

关键字 ：const

草案版本： @since draft-07

value必须等于定义的常量

{
	"const": "lisi"
}
或
{
	"const": 20
}

7.3 $schema

指定使用草案版本

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

7.4 metadata

关键字： $schema ，title，description，default，example

{
    "title" : "标题",
    "description" : "描述信息",
    "default" : "Default value",
    "examples" : [
        "Anything",
        4035
    ]
}

只作为描述作用，不影响对数据的校验。

piggy9512
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
JMeter支持JSON插件安装
隔壁老瓦的专栏
08-14 1488
https://github.com/runlittlesun/jmeter-jsonSchema-plugin jmeter-jsonSchema-plugin Validate JSON data by Using JSONSchema in JMeter 下载jmeter-jsonSchema-plugin.jar文件，放到Jmeter的/lib/ext 目录下，依赖的jar包也...
Paw-JSONSchemaFakerDynamicValue:在Paw中为JSON模式生成伪造的值
05-16
将Faker与JSON模式结合使用的简介 当描述JSON对象的整体体系结构时，JSON模式非常惊人。 这使它成为描述您的API期望和返回值的非常有用的工具。 感谢json-schema-faker，您可以自动生成与您的API期望相符的数据。 ...
JSON模式简介
04-11
JSON模式可能是处理JSON文件中大多数问题的答案。 我们从实际的角度探讨JSON Schema。
mongo 常用查询
weixin_41085315的博客
04-24 429
一： 对比 等于: $eq 例如： {'age':{'$eq':20}} 不等于: $ne 例如： {'age':{'$ne':20}} 大于: $gt 例如： {'age':{'$gt':20}} 大于等于: $gte 例如： {'age':{'$gte':20}} 在。。里: $in 例如： {'age':{'$in':[20,30]}} 不在。。里: $n...
Json Schema简介
weixin_30685047的博客
03-05 353
1. 引言 什么是Json Schema？ 以一个例子来说明 假设有一个web api，接受一个json请求，返回某个用户在某个城市关系最近的若干个好友。一个请求的例子如下： { "city" : "chicago", "number": 20, "user" : { "name":"Alex", "age":20 } ...
走近 JSON Schema
薛定谔的猫-前端领域
05-10 1072
JSON Schema 是用于验证 JSON 数据结构的强大工具，Schema可以理解为模式或者规则。
JSON Schema 进阶
戴泽王的博客
10-31 669
JSON Schema 学习
JSON Schema介绍2
赶路人儿
09-14 1437
上篇文章主要介绍了JSON Schema的标准、规范、实现（https://blog.csdn.net/liuxiao723846/article/details/108523139），接下来本文重点介绍JSON Schema的使用和示例。 三、快速开始 官网链接：http://json-schema.org/understanding-json-schema/ json schema在线校验工具：https://jsonschemalint.com/ json schema在线生成功能：ht.
JSON Schema校验数据
qq_41902662的博客
03-31 5009
JSON Schema
xdm:体验数据模型
03-30
阅读XDM规范 -包含XDM定义的所有模式项目布局该项目的布局方式如下： docs ：Markdown文件，其中包含XDM的主要内容，简介和非规范性部分schemas ：JSON架构文件，它们定义了开箱即用的跨用户模式components ：JSON...
databaseSchema:史上最low BiHTML项目
05-27
databaseSchema 简介 目的是构造一个JSON文件,文件包含所有的表关系,服务可以获取该JSON文件来自定义自己的构造格式。 支持类型 支持数据库模型 支持枚举类型 字段的类型通过yml配置来维护 创建模型 创建数据库模型...
yosegi:Yosegi是一种无模式的列式存储格式。 提供类似于JSON的灵活表示形式和类似于其他列存储格式的有效读取
05-05
八木简介这个项目做什么？ Yosegi是一种无模式的列式存储格式。 提供类似于JSON的灵活表示形式和类似于其他列存储格式的有效读取。为什么这个项目有用？ 存在一个问题，它太大了，无法像大数据时代那样压缩和保存...
JSON schema（模式）
梁辰兴的博客
11-13 5789
JSON Schema 译为“JSON模式”，它是由 IETF 编写和起草的。那么 JSON Schema 有什么作用呢？IETF 是 The Internet Engineering Task Force 的简称，译为“国际互联网工程任务组”，是一个公开性质的大型民间国际团体。{"id" : 1 , "name" : "JSON教程" , "author" : "C语言中文网" , "price" : 99.9 }
JSON Schema 简介
Bossen的学习历程
04-04 1159
JSON Schema是什么？ 根据 JSON Schema 规范 的定义，JSON模式是一种JSON媒体类型，用于定义JSON数据的结构。JSON模式旨在定义JSON数据的验证、文档、超链接导航和交互控制。 JSON模式的优势 JSON模式： 描述已经存在的数据格式 提供清晰的人类和机器可读的文档 验证数据： 自动化测试 确保客户端提交的数据的质量 JSON超模式： 使任何JSON格...
解析 JSON Schema 文档生成 Java 代码
CHENFU_ZKK的博客
09-23 882
解析 JSON Schema 文档生成 Java 代码
JsonSchema
Jimmy的博客
11-06 536
jsonshema用json描述json文件的格式，常用来校验json的格式；语法参见：Json Schema简介一个在线验证网站：https://www.jsonschemavalidator.net 我在使用中主要遇到两个问题： properties additionaProperties required的关系 properties描述可能出现的property格式 additionaProperties false or true表示是否可以出现比properties中列举的多余的property
python jsonschema使用
shitou987的博客
07-25 1151
1. 引言 json schema是基于json格式，用于验证json数据结构和数据内容。参考资料： 1.https://ajv.js.org/keywords.html 2.http://json-schema.org/ pytho安装jsonschema pip install jsonschema 验证： validate(data, schema) 什么是Json Schema？ Json Schema定义了一套词汇和规则，这套词汇和规则用来定义Json元数据，且元数据也是通过Json数据形式表达的
Json-schema
前端
07-16 6887
Json-schema 前端与服务器端的交互过程，大部分时候是使用的json格式 对于json还是比较了解，可是json-schema是什么？ json–JavaScript Object Notation JavaScript对象表示法 json-schema是一个用于验证json数据格式的工具，它本身也是使用json语言编写的 Json Schema定义了一套词汇和规则，这套词汇和规则用来定义Json元数据，且元数据也是通过Json数据形式表达的。Json元数据定义了Json数据需要满足的规范，规范包
Json（标题）
最新发布
m0_74107946的博客
04-28 179
将结构体转变为Json的过程叫编组，编组是通过json.Marshal函数完成的。json的对象类型可以用于编码Go语言中的map类型和结构体。Go语言对这些标准格式和编码都有良好的支持。json可以表示字符串，数字，布尔值和对象。类似的还有XML,ASN.1。是和在编译阶段关联到该成员的。
json schema
04-09
JSON Schema是一种用于描述JSON数据结构的规范。它定义了JSON对象的属性、类型、格式和约束条件等信息，可以用于验证和验证JSON数据的有效性。 JSON Schema具有以下特点： 1. 数据验证：可以定义JSON对象的属性类型、格式和约束条件，用于验证数据的有效性。 2. 数据描述：可以描述JSON对象的结构和属性，提供了一种标准的方式来描述和文档化JSON数据。 3. 数据生成：可以根据JSON Schema生成符合规范的示例数据，方便开发和测试。 4. 数据文档化：可以将JSON Schema作为文档，提供给其他开发人员或API用户参考。 以下是一些常见的JSON Schema关键字和用法： 1. type：指定属性的数据类型，如字符串、数字、布尔值等。 2. properties：定义对象的属性及其约束条件。 3. required：指定必需的属性。 4. enum：定义属性的取值范围。 5. format：指定属性的特定格式，如日期、时间、邮箱等。 6. pattern：使用正则表达式定义属性的模式。 7. additionalProperties：指定是否允许包含额外的属性。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值