启动架构
声明jsonschema:
schema 架构关键字,指出此架构是根据标准的特定草稿编写的
id 架构关键字,定义模式的URI,并解析模式中其他URI引用的基URI
title 和 description 关键字是描述性的,并不对数据具有约束作用,只是用来对文档作补充说明
type验证关键字定义我们的JSON数据的第一个约束,在这种情况下,它必须是一个JSON对象
type关键字指定对象或属性的类型
常用类型:
string:字符串 number:数字 integer:整型 boolean:布尔值 object:对象 array:数组
string 字符串的验证关键字
maxLength:此关键字的值必须是非负整数。如果字符串实例的长度小于或等于此关键字的值,则该字符串实例合法。
minLength:此关键字的值必须是非负整数。如果字符串实例的长度大于或等于此关键字的值,则该字符串实例合法。如果没有此关键字,则默认字符串实例的长度>=0。
pattern:该值为正则表达式。如果字符串实例与此正则表达式匹配,则认为字符串实例有效。
array 数组的验证关键字
items:array里每个元素的类型。如果items是一个object对象,则需要定义该对象下的每个元素校验模板,如果实例中的所有元素都匹配这些模板,则认为实例合法有效。如果items是一个array数组,则只需要定义一个元素的校验模板,所有实例中的所有元素都匹配这个模板,则认为实例合法有效。省略此关键字与空schema具有相同的效果。
maxItems:此关键字的值必须是非负整数。如果数组实例的元素个数小于或等于此关键字的值,则认为实例合法。
minItems:此关键字的值必须是非负整数。如果数组实例的大小大于或等于此关键字的值,则认为实例合法。如果没有此关键字,则数组元素的个数必须>=0。
uniqueItems:该关键字的值必须是布尔值。如果此关键字为false,则实例里的各元素可以相同;如果它为true,则实例里的各元素要各不相同才算合法有效。如果没有此关键字,则默认实例里的各元素可以相同。
contains:此关键字的值必须是有效的JSON格式。如果至少有一个元素对给定的模式有效,则数组实例对“contains”有效。
additionalItems:其值必须是有效的json格式,针对实例多出来的数据进行校验。如果值为false,则实例里只要有一个不匹配items,则无效。
dependencies:属性依赖,该关键字的值必须是一个对象。如果A依赖于B,则当存在A而没有B时,实例算是不合法的。
object 对象的验证关键字
type:类型
properties:其值必须是一个对象,且该对象的每个值必须是有效的JSON格式。必须得有这个关键字,如果没有则认为是空对象。
required:该关键字的值必须是一个数组。如果这个数组有元素的话,元素的类型必须是字符串,并且是唯一的。如果定义了这个关键字,那么表示实例中必须得有这个关键字里的元素,没有的话,则实例不合法。如果没有此关键字,则认为是空数组,则表明此对象下的元素都不是必须的。
maxProperties:此关键字的值必须是非负整数。如果对象实例的属性数小于或等于此关键字的值,则认为实例合法有效。
minProperties:此关键字的值必须是非负整数。如果对象实例的属性数大于或等于此关键字的值,则认为实例合法有效。如果没有此关键字,则认为实例属性个数>=0即可。
additionalProperties:其值必须是有效的JSON模式。此关键字确定子实例如何验证对象,而不直接验证直接实例本身。使用“additionalProperties”进行验证仅适用于与“properties”中的任何名称都不匹配的实例名称的子值,并且不匹配“patternProperties”中的任何正则表达式。对于所有此类属性,如果子实例针对“additionalProperties”架构进行验证,则验证成功。省略此关键字与空架构具有相同的行为。与additionalItems类似。如果值为false,则实例里只要有一个不匹配properties,则无效。
propertyNames:其值必须是有效的JSON格式,定义 properties的属性名称的格式。如果实例属性的名称不符合所定义的规则,则无效。
dependencies:属性依赖,该关键字的值必须是一个对象。如果A依赖于B,则当存在A而没有B时,实例算是不合法的。例子见数组模块。
patternProperties:其值必须是一个对象,用正则表达式去定义 properties的属性名称的格式。如果实例属性的名称不符合所定义的规则,则无效。
integer 整型的验证关键字
minimum:该关键字的值必须是一个数字,表示数字实例的包含下限。当实例大于或等于此值时,该实例才合法。
maximum:该关键字的值必须是一个数字,表示数字实例的包含上限。当实例小于或等于此值时,该实例才合法。
exclusiveMinimum:如果存在此关键字并且为 true,则表明实例仅在其值严格大于(不等于) "minimum" 的值时才算合法有效
exclusiveMaximum:如果存在此关键字并且为 true,则表明实例仅在其值严格小于(不等于) "maximum" 的值时才算合法有效
multipleOf:其值必须是大于0的整数,仅当实例被这个关键词的值除以之后的结果是一个整数时,这个实例才是有效的。
enum:该关键字的值是数组,实际返回的字段值在这个数组里,才算有效
number 数字的验证关键字
此关键字可以描述任意长度,任意小数点的数字。
minimum:该关键字的值必须是一个数字,表示数字实例的包含下限。当实例大于或等于此值时,该实例才合法。
maximum:该关键字的值必须是一个数字,表示数字实例的包含上限。当实例小于或等于此值时,该实例才合法。
exclusiveMinimum:如果存在此关键字并且为 true,则表明实例仅在其值严格大于(不等于) "minimum" 的值时才算合法有效
exclusiveMaximum:如果存在此关键字并且为 true,则表明实例仅在其值严格小于(不等于) "maximum" 的值时才算合法有效
其他关键字
boolean :就两种情况:true或者false
enum:其值必须是数组,列出所有情况,如果实例的值不在这个数组里,则实例无效
null:空
const:其值可以是任意类型,包括null,只要实例的返回值跟这个值一模一样,则实例有效合法
架构外的引用
可在schema内部引用另外一个schema来合并验证
目的:重用,可读性和可维护性
warehouseLocation关键字和ref关键字
例如:
"warehouseLocation": {
"description": "Coordinates of the warehouse where the product is located.",
"$ref": "https://example.com/geographical-location.schema.json"
}
ref的值为被引用的schema的$id
架构内的引用
可在schema内部引用另外一个schema来合并验证
definitions关键字和ref关键字
例如:
{
"vegetables": {
"type": "array",
"items": { "$ref": "#/definitions/veggie" }
}
},
"definitions": {
"veggie": {
"type": "object",
"required": [ "veggieName", "veggieLike" ],
"properties": {
"veggieName": {
"type": "string",
"description": "The name of the vegetable."
},
"veggieLike": {
"type": "boolean",
"description": "Do I like this vegetable?"
}
使用条件应用于子模式的关键字
这些关键字一起工作以基于另一个子模式的结果实现子模式的条件应用。
if
此关键字的值必须是有效的JSON格式。
此关键字的子模式的验证结果对整体验证结果没有直接影响。相反,它控制了哪个“then”或“else”关键字被判断。
成功验证此关键字的子模式的实例必须对“then”关键字的子模式值(如果存在)有效。
无法针对此关键字的子模式进行验证的实例也必须对“else”关键字的子模式值(如果存在)有效。
then
此关键字的值必须是有效的JSON格式。
当“if”存在且实例成功验证其子模式时,如果实例也成功验证此关键字的子模式,则valiation将成功对该关键字进行验证。
当“if”不存在时,或者实例无法针对其子模式进行验证时,此关键字无效。
else
此关键字的值必须是有效的JSON格式。
当“if”存在且实例无法针对其子模式进行验证时,如果实例成功验证此关键字的子模式,则valiation将成功对该关键字进行验证。
当“if”不存在时,或者实例成功验证其子模式时,此关键字无效。
使用布尔逻辑应用子模式的关键字
allOf:该关键字的值必须是非空数组,数组的每个项必须是有效的JSON模式,意思是展示全部属性。如果实例针对此关键字的值定义的所有模式成功验证,则实例才算合法有效。
anyOf:该关键字的值必须是非空数组,数组的每个项必须是有效的JSON模式,意思是展示任意属性。如果实例针对此关键字的值定义的至少一个模式成功验证,则实例就算合法有效。
oneOf:该关键字的值必须是非空数组,数组的每个项必须是有效的JSON模式,意思是满足其中一个属性。如果实例针对此关键字的值定义的有且只有一个模式成功验证,则实例就算合法有效。
not:此关键字的值必须是有效的JSON模式,非 * 类型。如果实例无法针对此关键字定义的模式成功验证,则实例就算合法有效。
具体使用参考:https://blog.csdn.net/weixin_42534940/article/details/103615260
备注
1、https://jsonschema.net/previous 这个网站可以生成基础的schema校验模板,但是有可能是有错的,得自己再检查并补充修改
2、填写正则表达式之后最好再检查一下数据的json格式是否正确,因为部分正则表达式可能因为部分字符让json格式校验不通过
3、type也可以写成数组类型