JSON Schema及其用法

本篇主要介绍JSON Schema的基本语法，必要时会使用python代码来验证。

  JSON Schema是一种用于描述JSON数据的规范，可以用来定义JSON数据对象的结构、格式和约束条件。通过JSON Schema，可以对JSON数据进行验证、校验和文档化，确保数据的正确性和完整性。

1 Json Schema基本语法

  JSON Schema能校验JSON数据，但JSON Schema本身也是一种JSON结构。JSON Schema的基本语法中主要包括以下几个关键词：

具体举例如下：

from jsonschema import validate
schema={"type": "string"}
schema1={ "type":"object"}  
data={ "message": "Hello"}
def json_validate(data,schema):
    try:
        validate(instance=data, schema=schema)
        print("Valid")
    except:
        print("Invalid")

json_validate(data,schema)
json_validate(data,schema1)

其输出内容为：

Invalid
Valid

2 JSON Schema类型

  虽然前文中type中的关键字为object时才能校验JSON数据，但是type关键字还可以有其他取值，并且不同数据类型有各自其他限定的关键词。 type关键字可取值有：object、string、array、integer、number、boolean、null。boolean和null并没有相关的限定关键词，这里就不介绍了。
JSON Schema实际上是一个嵌套结构，下面的很多关键词的取值也可以是一个JSON Schema格式。

2.1 object类型

object类型类似于Python中的字典(dict)类型，其限定关键词主要有以下几个：

具体举例如下：

from jsonschema import validate
schema={
    "type": "object",
    "properties": {
        "message": {"type": "string"}
    },
    "required": ["message","role"],
    "additionalProperties": False, 
}
data={
    "role":"system",
    "message":"你是谁啊"
}
def json_validate(data,schema):
    try:
        validate(instance=data, schema=schema)
        print("Valid")
    except:
        print("Invalid")
json_validate(data,schema)

具体结果如下：

Invalid

2.2 string型

string类型限定的关键词主要有以下：

举例如下：

from jsonschema import validate
schema={
    "type": "object",
    "properties": {
        "message": {"type": "string"},
        'date': {"type": "string",
                "format": "date"}
    },
    "required": ["message","role"],
    "additionalProperties": True,
}
data={
    "role":"system",
    "message":"你是谁啊",
    "date":"2024-03-30"
}
def json_validate(data,schema):
    try:
        validate(instance=data, schema=schema)
        print("Valid")
    except:
        print("Invalid")

json_validate(data,schema)

2.3 numeric型

JSON schema中的numeric型有两种取值：number(类似于Python中的float型和int型)和integer(仅类似于Python中int型)。所以这里重点介绍number，其限定的关键词包括以下几种：

举例如下：

from jsonschema import validate

schema={
    "type": "object",
    "properties": {
        "num":{"type":"number",
                "multiplesOf":10,
                "miximum":20,
                "maximum":300}
            }
}
data={
    "num":230
}
def json_validate(data,schema):
    try:
        validate(instance=data, schema=schema)
        print("Valid")
    except:
        print("Invalid")

json_validate(data,schema)

其结果如下：

Valid

2.4 array型

array型类似于类似于python中的list型和tuple型，其限定的关键词主要有以下：

举例如下：

from jsonschema import validate
schema={
    "type": "object",
    "properties": {
        "num": {
            "type": "array",
            "prefixItrems": [
               { "type": "number"},
               {"type":"string"}
            ],
            "unevaluatedItems": True
        }
    }
}
data={"num":[1,'hello',5.4]}
def json_validate(data,schema):
    try:
        validate(instance=data, schema=schema)
        print("Valid")
    except:
        print("Invalid")
json_validate(data,schema)

其结果如下：

Valid

3 其他

除了以上介绍的关键词之外，还有一些其他的常用关键词，具体如下：

• enum: 枚举类型。
• const：常数。
• contentMediaType：
• contentEncoding：

参考资料：

1. https://json-schema.org/understanding-json-schema/reference
2. https://zhuanlan.zhihu.com/p/72607132