标签：description json 接口 JSON jsonschema Schema schema

JSON Schema简介：

json是数据交互的常用数据格式，JSON Schema是对json数据约束的一个标准。

JSON Schema官网：

JSON Schema | The home of JSON Schema

JSON Schema官网教程：

Getting Started Step-By-Step | JSON Schema

JSON Schema校验工具：

JSON Schema Validator - Newtonsoft

JSON Schema使用方式：

JsonSchemaUtil.json_schema(instance=json_data, schema=my_schema)

该函数首先验证所提供的schema本身是否有效（无效，则抛出 jsonschema.exceptions.SchemaError 异常），然后再验证json数据（校验不通过，则抛出 jsonschema.exceptions.ValidationError 异常）

JSON Schema应用：

 python代码如下：

import jsonschema


def json_schema(cls, json_data):
    json_schema = {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "$id": "https://example.com/product.schema.json",
        "title": "iHRM断言",
        "description": "响应体的数据校验",
        "type": "object",
        "properties":
            {
                "success": {
                    "description": '操作成功标记',
                    "type": "boolean",
                    "const": True
                },
                "code": {
                    "description": '错误码',
                    "type": "number",
                    "const": 10000
                },
                "message": {
                    "description": '消息',
                    "type": "string",
                    "pattern": "成功"
                },
                "data": {
                    "description": '响应返回的数据，失败返回空'
                }
            },
        "required": ["success", "code", "message"]
    }

    # 验证：
    jsonschema.validate(instance=json_data, schema=json_schema)

标签：description,json,接口,JSON,jsonschema,Schema,schema
来源： https://blog.csdn.net/ShylockJIE/article/details/121761461

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。