当前位置:网站首页>技术分享 | 接口自动化测试之JSON Schema模式该如何使用?
技术分享 | 接口自动化测试之JSON Schema模式该如何使用?
2022-08-09 21:35:00 【hog_ceshiren】
JSON Schema 模式是一个词汇表,可用于注释和验证 JSON 文档。在实际工作中,对接口返回值进行断言校验,除了常用字段的断言检测以外,还要对其他字段的类型进行检测。对返回的字段一个个写断言显然是非常耗时的,这个时候就需要一个模板,可以定义好数据类型和匹配条件,除了关键参数外,其余可直接通过此模板来断言,JSON Schema 可以完美实现这样的需求。
JSON Schema 官网:
http://json-schema.org/implementations.html
环境准备
安装 JSON Schema 包
- Python 版本
pip install jsonschema
- Java 版本
<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>json-schema-validator</artifactId>
<version>3.0.1</version>
</dependency>
JSON Schema 的使用
JSON Schema 模板生成
首先要借助于 JSON Schema tool 的网站 https://www.jsonschema.net/,将返回 json 字符串复制到页面左边,然后点击 INFER SHCEMA,就会自动转换为 schema json 文件类型,会将每个地段的返回值类型都设置一个默认类型,在 pattern 中也可以写正则进行匹配。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-K12bEfqU-1659923704774)(upload://rWFXH62wcBJrNH0xcCf6O7w1UJA.png)]
点击“设置”按钮会出现各个类型返回值更详细的断言设置,这个就是 schema 最常用也是最实用的功能。也可以对每种类型的字段最更细化的区间值校验或者断言,例如长度、取值范围等。
点击复制按钮,可以将生成的 schema 模板保存下来。
实战练习
接下来会发起一个 post 请求,验证响应值中的 url 字段与 origin 字段是否都为 string 类型。
Python版本
import requests
from jsonschema import validate
def test_schema():
schema = {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"origin": {
"type":"string"
}
}
}
r = requests.post("https://httpbin.ceshiren.com/post")
validate(instance=r.json(), schema=schema)
如果将 origin 的 type 写成 number ,则会出现报错:
import requests
from jsonschema import validate
def test_schema():
schema = {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"origin": {
"type":"number"
}
}
}
r = requests.post("https://httpbin.ceshiren.com/post")
validate(instance=r.json(), schema=schema)
返回报错信息
> raise error
E jsonschema.exceptions.ValidationError: 'xxx.xxx.xxx.xxx' is not of type 'number'
E Failed validating 'type' in schema['properties']['origin']:
E {'type': 'number'}
同理,若将 url 的 type 改为 number,也会有报错提示。
> raise error
E jsonschema.exceptions.ValidationError: 'https://httpbin.ceshiren.com/post' is not of type 'number'
E Failed validating 'type' in schema['properties']['url']:
E {'type': 'number'}
Java 版本
JsonValidator.json 文件中存放校验文件,校验响应值中的 url 字段与 origin 字段是否都为 string 类型,文件内容为:
"type": "object",
"properties": {
"url": {
"type": "string"
},
"origin": {
"type":"string"
}
}
}
同 Python 版本一致,以下代码校验响应值是否符合 JsonValidator.json 文件中规定的格式要求。
import static io.restassured.module.jsv.JsonSchemaValidator.matchesJsonSchemaInClasspath;
import static io.restassured.RestAssured.*;
public class Requests {
public static void main(String[] args) {
//定义请求头信息的contentType为application/json
given().when().
post("https://httpbin.ceshiren.com/post").
then().assertThat().
body(matchesJsonSchemaInClasspath("JsonValidator.json"));
}
}
️ 复制“下方链接”,提升测试核心竞争力!
你好呀,喜欢这篇文章的话记得点个“赞”哦!大家的支持很重要~(▽) PS:有问题可以联系我们哦
边栏推荐
- 企业数据打通有什么好处?不同行业怎么解决数据打通难题?
- Simulation of Water Temperature Control System Based on Fuzzy PID Controller
- MySQL跨表、多表更新SQL语句总结
- Two methods of implementing inverted strings in C language
- 【云原生】4.2 DevOps 精讲篇
- Don't tell me to play, I'm taking the PMP exam: what you need to know about choosing an institution for the PMP exam
- 小黑leetcode清爽雨天之旅,刚吃完宇飞牛肉面、麻辣烫和啤酒:112. 路径总和
- Visual studio 2022 debugging skills introduction
- Puyuan Jingdian turned losses into profits in the first half of the year, and high-end products continued to develop!Are you optimistic about "Huawei" in the instrument industry?
- 题解:Edu Codeforces 109(div2)
猜你喜欢
Ankerui supports Ethernet communication, profibus communication embedded energy meter APM guiding technical requirements-Susie Week
【云原生】4.2 DevOps 精讲篇
Two methods of implementing inverted strings in C language
Word怎么制作一张标准的答题卡?
人人都可以DIY的大玩具,宏光MINIEV GAMEBOY产品力强,出行新装备
hdu 1503 Advanced Fruits(最长公共子序列的应用)
小黑leetcode之旅:94. 二叉树的中序遍历(补充Morris 中序遍历)
buuctf(探险2)
字节二面问的MySQL,差点没答好
Definition and Basic Operations of Sequence Tables
随机推荐
matlab neural network ANN classification
linux定时执行sql文件[通俗易懂]
DSPE-PEG-Azide, DSPE-PEG-N3, phospholipid-polyethylene glycol-azide can react directly with DBCO
Excel如何打出正负号?Excel打出正负号的方法
mysql多表左链接查询
LoRa Basics无线通信技术和应用案例详解
How to fix Windows 11 not finding files
leetcode:数组中的第K个最大元素
fixed investment fund
MySQL Notes-06 Basic SQL Operations
编程语言中,取余和取模的区别
【泛型编程】模板全详解
Word文档怎么输入无穷大符号∞
Jensen (琴生) 不等式
Access control knowledge
URL Protocol web page to open the application
Unity_平滑移动
buuctf(探险2)
Problems with compiling SIP with QGIS
蓝牙模块有哪些种类?BLE低功耗蓝牙模块有什么特点?