接口测试框架实战之搞定 Schema 断言

发表于:2021-11-03 09:36

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:佚名    来源:知乎

  JSON Schema 简介与安装
  JSON Schema 是描述 JSON 数据结构的一种格式,JSON Schema 模式是一个词汇表。通过 JSON Schema 可以注释 JSON 的字段以及字段数据类型等信息。
  在实际工作中,对接口返回值进行断言校验,除了常用字段的断言检测以外,还要对其他字段的类型进行检测。对返回的字段一个个写断言显然是非常耗时的,这个时候就需要一个模板,可以定义好数据类型和匹配条件,除了关键参数外,其余可直接通过此模板来断言,Json Schema 可以完美实现这样的需求。通过校验 JSON Schema 就可以判断 Response 是否符合约定。
  一个 JSON 格式的数据,通常是由以下一种或多种数据类型组成的:
  1. string
  2. Numeric(integer、number)
  3. object
  4. array
  5. boolean
  6. null
  JSON Schema 中对上面的 6 种数据类型,都有相应的属性对其进行描述。
  Json Schema 官网:http://json-schema.org/implementations.html
  环境准备
  安装 JSON Schema 包:
  pip install jsonschema
  JSON Schema 的使用
  JsonSchema 模板生成
  1. 首先要借助于 Json Schema Tool 的网站:
  https://www.jsonschema.net/
  将返回 JSON 字符串复制到页面左边,然后点击 INFER SHCEMA,就会自动转换为 Schema JSON 文件类型,会将每个地段的返回值类型都设置一个默认类型;在 pattern 中也可以写正则进行匹配:
  2. 点击“设置”按钮会出现各个类型返回值更详细的断言设置,这个就是 Schema 最常用也是最实用的功能,也可以对每种类型的字段最更细化的区间值校验或者断言,例如长度,取值范围等。
  3. 点击复制按钮,可以将生成的 Schema 模板保存下来。
  JSON Schema 校验案例
  下面有个 JSON Schem 例子,它只有两个重要字段 name 和 price。这个 schema 规定 name 必须是 string 类型,price 必须是 number 类型。使用 JSON Schema 进行校验,使用 validate 方法,输入一个 name 为 Eggs 和 price 为 34.99 的数据进行校验:
  def test_schema(self):
      schema = {
          "type": "object",
          "properties": {
              "price": {"type": "number"},
              "name": {"type":"string"},
          },
  }
  validate(instance={"name": "Eggs", "price": 34.99},schema=schema)
  如果将 number 写成 string,则会出现报错:
  >>> from jsonschema import validate
  >>> schema = {
  ...     "type": "object",
  ...     "properties": {
  ...         "price": {"type": "string"},
  ...         "name": {"type":"string"},
  ...     },
  ... }
  >>> validate(instance={"name": "Eggs", "price": 34.99},schema=schema)
  返回报错信息:
  Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
    File "/Users/lixu/Library/Python/3.7/lib/python/site-packages/jsonschema/validators.py",\
     line 934, in validate
      raise error
  jsonschema.exceptions.ValidationError: 34.99 is not of type 'string'
  以上,JSON Schema 作为接口测试的数据校验利器让工作变得更加高效,也更好的实现了接口监控,能知道哪里出了问题并及时纠正。更多内容,在后续章节探讨。

  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理

《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号