推荐一款接口自动化测试数据提取神器 JSonPath

image

在之前分享中,给大家介绍过一篇:如何快速审核接口返回值全部字段解决方案,详见原文:接口自动化测试,一键快速校验接口返回值全部字段 。当时,提到解决这类问题,市面上常见的解决方案有两种:

  • 根据业务校验需求,自定义开发校验规则库
  • 借助现有的第三方库

而文章中介绍到的方案,就是借助现有的第三方库来实现:DeepDiff 。对于一些特殊业务或者复杂的测试场景来说,这类通用方案,总会有一些需求无法满足。因此往往还需要根据这类业务校验需求,自定义开发校验规则库。

我们今天不讲如何开发一款自定义开发校验规则库,而是给大家分享一款在开发自定义校验规则库或者常规的接口自动化测试时,经常会用到的一款数据提取神器:JSonPath

1. JSonPath介绍

JSonPath是一种简单的方法来提取给定JSON文档的部分内容。 JSonPath有许多编程语言,如JavascriptPythonPHPJava等。

JSonPath提供的json解析非常强大,它提供了类似正则表达式的语法,基本上可以满足所有你想要获得的JSON内容。

项目地址:

https://github.com/json-path/JsonPath

一句话概括:JsonPath就是用来解析提取Json数据用的

2. JSonPath语法

JSONPath 是参照,Xpath表达式来解析XML文档的方式,JSON数据结构通常是匿名的并且不一定需要有根元素。JSONPaht 用一个抽象的名字****来表示最外层对象,即 代表整个JSON数据的值。

JSonpath的语法如下:jsonpath.jsonpath()

  • 参数:json对象,jsonpath表达式

  • 返回值:列表

JSONPath 表达式可以使用. 符号如下:

$.store.book[0].title

或者使用[] 符号

$['store']['book'][0]['title']

JSONPath 允许使用通配符 * 表示所以的子元素名和数组索引,还允许使用 '..' 。

表达式在下面的脚本语言中可以使用显示的名称或者索引:

$.store.book[(@.length-1)].title

使用'@'符号表示当前的对象,?(<判断表达式>) 使用逻辑表达式来过滤。

$.store.book[?(@.price > 100)].title

其中XPathJSONPath语法区别如下:

image

需要额外注意的是

  • []在xpath表达式总是从前面的路径来操作数组,索引是从1开始。
  • 使用JOSNPath的[]操作符操作一个对象或者数组,索引是从0开始。

3. JsonPath实战使用

安装:

pip install jsonpath

例如:待提取的json数据变量名为: json_datas

json_datas = {"store": {
    "book": [
      { "category": "测试开发技术",
        "author": "狂师",
        "title": "公众号:测试开发技术",
        "price": 129
      },
      { "category": "自动化测试",
        "author": "狂师1",
        "title": "《自动化测试实战宝典》",
        "price": 109
      },
      { "category": "Python",
        "author": "狂师2",
        "title": "Python实战教程",
        "isbn": "0-110-234567-30",
        "price": 99
      },
      { "category": "Java",
        "author": "狂师3",
        "title": "小白学Java",
        "isbn": "0-13095-19295-8",
        "price": 89
      }
    ],
    "info": {
      "color": "red",
      "price": 88
    }
  }
}
1. 查找book下面所有的author
import jsonpath
datas = jsonpath.jsonpath(json_datas, '$.store.book[*].author')
print(datas)

输出结果为:['狂师', '狂师1', '狂师2', '狂师3']

上述提取表达式,可以改为如下:

datas = jsonpath.jsonpath(json_datas, '$..author')
print(datas)

具备同等效果,输出所有author,结果同样为:['狂师', '狂师1', '狂师2', '狂师3']

2. 查找store下面book所有节点数据
datas = jsonpath.jsonpath(json_datas, '$.store.book.*')
print(datas)

输出结果为:

[{'category': '测试开发技术', 'author': '狂师', 'title': '公众号:测试开发技术', 'price': 129}, {'category': '自动化测试', 'author': '狂师1', 'title': '《自动化测试实战宝典》', 'price': 109}, {'category': 'Python', 'author': '狂师2', 'title': 'Python实战教程', 'isbn': '0-110-234567-30', 'price': 99}, {'category': 'Java', 'author': '狂师3', 'title': '小白学Java', 'isbn': '0-13095-19295-8', 'price': 89}]
3. 查找book下面第三个book
datas = jsonpath.jsonpath(json_datas, '$.store.book[2]')
print(datas)

输出结果为:

[{'category': 'Python', 'author': '狂师2', 'title': 'Python实战教程', 'isbn': '0-110-234567-30', 'price': 99}]
4. 查找book下面最后个book,返回的是一个列表
datas = jsonpath.jsonpath(json_datas, '$.store.book[(@.length-1)]')
print(datas)

输出结果:

[{'category': 'Java', 'author': '狂师3', 'title': '小白学Java', 'isbn': '0-13095-19295-8', 'price': 89}]
5.查找 book下面前3本书
datas = jsonpath.jsonpath(json_datas, '$.store.book[0,2]')
print(datas)

输出结果为:

[{'category': '测试开发技术', 'author': '狂师', 'title': '公众号:测试开发技术', 'price': 129}, {'category': 'Python', 'author': '狂师2', 'title': 'Python实战教程', 'isbn': '0-110-234567-30', 'price': 99}]
6. 查找所有的包含isbn这个键的所有book
datas = jsonpath.jsonpath(json_datas, '$.store.book[?(@.isbn)]')
print(datas)

输出结果为:

[{'category': 'Python', 'author': '狂师2', 'title': 'Python实战教程', 'isbn': '0-110-234567-30', 'price': 99}, {'category': 'Java', 'author': '狂师3', 'title': '小白学Java', 'isbn': '0-13095-19295-8', 'price': 89}]
7. 查找价格大于100的所有书
datas = jsonpath.jsonpath(json_datas, '$.store.book[?(@.price>100)]')
print(datas)

输出结果:

[{'category': '测试开发技术', 'author': '狂师', 'title': '公众号:测试开发技术', 'price': 129}, {'category': '自动化测试', 'author': '狂师1', 'title': '《自动化测试实战宝典》', 'price': 109}]

4. 最后,JsonPath小技巧

最后再给大家推荐一个技巧,如果一开始对JSONPath表达式不太熟悉,可以将需要提取的JSON数据,通过jsonpath在线解析工具测试一下,在线解析JSONPath网址很多,例如:

http://www.e123456.com/aaaphp/online/jsonpath/
image

在接口自动化测试中,只有你懂得利用好JSONPath,那么至少可以让你在自动化测试数据提取这块,随心所欲的提取自己要想的数据。

好了,今天的干货分享就到这了,你学会了吗?

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,590评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,808评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,151评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,779评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,773评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,656评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,022评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,678评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,038评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,411评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,005评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2 343

推荐阅读更多精彩内容