『居善地』接口测试 — 13.接口自动化测试框架实现（二）

3、封装获取接口返回结果指定内容

该文件是封装处理返回值结果的一些方法。

我们需要用到一个Python中的模块JsonPath，下面就先来介绍一下JsonPath模块。

（1）JsonPath介绍

用来解析多层嵌套的Json数据。

JsonPath是一种信息抽取类库，是从JSON文档中抽取指定信息的工具，提供多种语言实现版本，包括：Javascript，Python， PHP 和 Java。

JsonPath 对于 JSON 来说，相当于 XPath 对于 XML。

（2）JsonPath安装

安装方法：pip install jsonpath

使用方法如下：

# 导入jsonpath模块
import jsonpath模块

# 嵌套n层也能取到所有key_nane信息，
# 其中："$"表示最外层的{}，
# ".."表示模糊匹配，
# 当传入不存在的key_nane时，程序会返回false。

res = jsonpath.jsonpath(response, f"$..{keyword}")[0]

"""
jsonpath方法说明
jsonpath(obj, expr, result_type='VALUE', debug=0, use_eval=True):

# obj表是要处理的json对象。
# expr是jsonpath匹配表达式。$..{keyword} 这种方式比较通用
"""

JsonPath官方文档：http://goessner.net/articles/JsonPath

github上有它的应用：https://github.com/json-path/JsonPath（Java中的JsonPath使用文档）

（3）JsonPath与XPath语法对比

Json结构清晰，可读性高，复杂度低，非常容易匹配，下表中对应了XPath的用法。

XPath	JSONPath	描述
/	$	根节点
.	@	现行节点
/	.or[]	取子节点
..	n/a	取父节点，Jsonpath未支持
//	..	就是不管位置，选择所有符合条件的条件
*	*	匹配所有元素节点
@	n/a	根据属性访问，Json不支持，因为Json是个Key-value递归结构，不需要属性访问。
[]	[]	迭代器标示（可以在里边做简单的迭代操作，如数组下标，根据内容选值等）
|	[,]	支持迭代器中做多选。
[]	?()	支持过滤操作.
n/a	()	支持表达式计算
()	n/a	分组，JsonPath不支持

（4）getKeyword_forResult.py文件实现

"""
getKeyword_forResult.py文件说明：
1.作用
    在接口返回值中，通过关键获取获取对应字段内容
2，前提：需要安装一个库：jsonpath库
    安装jsonpath ： pip install jsonpath
    使用jsonpath模块进行处理更加方便

"""
# 导入jsonpath模块
import jsonpath


# 封装获取接口返回值方法
class GetKeyword:
    # 定义成一个静态方法
    @staticmethod
    def get_keyword(response: dict, keyword):
        """
        通过关键字获取对应返回值,如果有多个值,只返回第一个,
        如果关键字不存在,返回False。
        :param:response 数据源  字典格式
        :param:keyword 要获取的字段
        :return:
        """
        try:
            return jsonpath.jsonpath(response, f"$..{keyword}")[0]
        except:
            print("关键字不存在")

    @staticmethod
    def get_keywords(response: dict, keyword):
        """
        通过关键字获取一组数据
        :param response: 数据源 dict格式
        :param keyword:  如果关键字不存在,返回False
        :return:
        """
        try:
            return jsonpath.jsonpath(response, f"$..{keyword}")
        except:
            print("关键字不存在")


if __name__ == '__main__':
    response = {
        "count": 2,
        "next": "下一页",
        "previous": None,
        "results": [
            {
                "dep_id": "10",
                "dep_name": "tester_10",
                "master_name": "master_10",
                "slogan": "随便"
            },
            {
                "dep_id": "11",
                "dep_name": "tester_11",
                "master_name": "master_11",
                "slogan": "随便"
            }
        ]
    }
    keyword = "dep_id"
    # print(GetKeyword.get_keyword(response, keyword))
    print(GetKeyword.get_keywords(response, keyword))

4、接口目录中的方法的实现

每一个接口或者一类接口封装成一个interface（也就是一个接口对应一个.py文件）

• 对该接口的请求：用于单接口测试。
• 根据业务获取接口返回值：用于关联接口测试。

（关于一个接口，所对应要测试哪几个方面的业务，都封装到该文件中，会用到上面commn目录中封装好的公共方法）

示例如下：

（1）示例1：封装新增学院接口

"""
新增学院接口
1.单接口测试方法
2.关联接口测试方法
    获取返回值中的字段
"""
# 导入自定义的公共方法
from common.send_method import SendMethod
from common.getKeyword_forResult import GetKeyword


# 封装新增学院接口测试
class Add_department:

    # url和请求方式对于一个接口来说是固定的，
    # 所以这两个参数可以写在初始化方法中。
    def __init__(self, url, method="post"):
        self.method = method
        self.url = url

    def add_dep(self, data):
        """
        定义新增学院接口：针对单接口测试
        :param data: 新增学院的请求参数
        :return:
        """
        return SendMethod.send_method(self.method, url=self.url, json=data)

    def get_keyword(self, data, keyword):
        """
        获取新增成功后的关键字值：为关联接口测试准备
        :param data:
        :param keyword:
        :return:
        """
        res = self.add_dep(data)

        # 获取新增学院接口返回值中的学院的具体某一属性
        return GetKeyword.get_keyword(res, keyword)


if __name__ == '__main__':
    url = "http://127.0.0.1:8000/api/departments/"
    data = {
        "data": [
            {
                "dep_id": "T03",
                "dep_name": "Test学院",
                "master_name": "Test-Master",
                "slogan": "Here is Slogan"
            }
        ]
    }
    add = Add_department(url)
    res = add.add_dep(data)  # 新增学院接口方法
    print(res)
    keyword = "dep_id"
    dep_id = add.get_keyword(data, keyword)  # 获取新增成功后depid
    print(dep_id)

（2）示例2：封装查询学院接口

"""
get_dep.py文件说明：
1.查询接口测试
2.获取查询接口返回值
"""
from common.send_method import SendMethod


class Get_Departments:
    def __init__(self, url, method="get"):
        self.url = url
        self.method = method

    def get_departments(self):
        """
        查询所有学院
        :return:
        """
        return SendMethod.send_method(method=self.method, url=self.url)

    def get_department(self, dep_id):
        """
        根据id查询单个学院
        :return:
        """
        url = self.url + f"{dep_id}/"
        return SendMethod.send_method(method=self.method, url=url)

    def get_department_for_multpart(self, data):
        """
        根据参数查询学院
        :return:
        """
        return SendMethod.send_method(method=self.method, url=self.url, parmas=data)


if __name__ == '__main__':
    url_1 = "http://127.0.0.1:8000/api/departments/"
    data = {"$dep_id_list": "12,13"}
    get_dep = Get_Departments(url=url_1)
    # 查询所有学院
    # print(get_dep.get_departments())
    # 查询指定学院
    dep_id = 16
    # print(get_dep.get_department(dep_id))
    # 根据条件查询学院
    print(get_dep.get_department_for_multpart(data))