16.整体结构响应断言

目录

• 结构断言介绍
• JSONSchema 数据生成
• JSONSchema 验证

响应信息数据极为庞大

https://ceshiren.com/t/topic/16658.json

针对于“大响应数据”如何断言

• 针对主要且少量的业务字段断言。
• 其他字段不做数据正确性断言，只做类型与整体结构的校验。
• 与前面的版本进行 diff，对比差异化的地方。

JSONSchema 简介

• 使用 JSON 格式编写的
• 可以用来定义校验 JSON 数据的结构
• 可以用来校验 JSON 数据的一致性
• 可以用来校验 API 接口请求和响应

JSONSchema 整体结构响应断言

1. 预先生成对应结构的 Schema。
2. 将实际获取到的响应与生成的 Schema 进行对比。

JSONSchema 的生成

• 通过界面工具生成。
• 通过第三方库生成。
• 通过命令行工具生成。

JSONSchema 的生成效果

// # 预期的 JSON 文档结构
{
  "name": "Hogwarts",
  "Courses": ["Mock", "Docker"]
}

// jsonschema
{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$ref": "#/definitions/Welcome",
  "definitions": {
    "Welcome": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "Courses": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": ["Courses", "name"],
      "title": "Welcome"
    }
  }
}

界面工具生成

• 复制 JSON 数据
• 粘贴到在线生成工具中
• 自动生成 JSON Schema 数据

JSON Schema 在线生成工具：https://app.quicktype.io

第三方库生成（Python）

1. 安装：pip install genson。
2. 调用方法生成对应的 JSONSchema 数据结构。

from genson import SchemaBuilder
def generate_jsonschema(obj):
    # 实例化jsonschem
    builder = SchemaBuilder()
    # 传入被转换的对象 
    builder.add_object(obj)
    # 转换成 schema 数据
    return builder.to_schema()

JSONSchema 验证（Python）

1. 安装：pip install jsonschema。
2. 调用 validate() 进行验证。

def schema_validate(obj, schema):
    '''
    对比 python 对象与生成的 JSONSchame 的结构是否一致
    '''
    try:
        validate(instance=obj, schema=schema)
        return True
    except Exception as e:
        return False

JSONSchema 二次封装

• 生成JSONSchema
• 验证JSONSchema

class JSONSchemaUtils:
    @classmethod
    def generate_schema(cls, obj):
        # 实例化jsonschem
        builder = SchemaBuilder()
        # 传入被转换的对象 
        builder.add_object(obj)
        # 转换成 schema 数据
        return builder.to_schema()

    @classmethod
    def schema_validate(cls, obj, schema):
        '''
        对比 python 对象与生成的 json schame 的结构是否一致
        '''
        try:
            validate(instance=obj, schema=schema)
            return True
        except Exception as e:
            return False