化繁为简！用pytest编写接口自动化测试脚本的简易思路

野性酷女 2024-03-23 13:36 80阅读 0赞

#### **目录**：导读 ####

引言

一，明确测试对象

二，编写测试用例

构造请求数据

封装测试代码

断言设置

三，执行脚本获取测试结果

四，总结

写在最后

--------------------

### 引言 ###

当今互联网时代，软件质量成为越来越重要的一个问题，而接口自动化测试是保障软件质量的一种关键手段。

在这个过程中，pytest成为了许多开发者的首选工具，既易于使用，又具有强大的功能。但是，对于初学者来说，编写自己的pytest测试脚本可能会感到有些困难。

**本文将为您提供一些思路和方法，帮助您更轻松地编写符合需求的接口自动化测试用例。**

话不多说直接开始我们的实战。

我们在百度搜索`天气查询`，会出现如下图所示结果：

![071be6599dc2005d1bd858ece28a01db.png][]

接下来，我们以该天气查询接口为例，编写接口测试用例脚本。

### 一，明确测试对象 ###

针对某个功能做接口测试，首先我们需要确定实现这个功能调用的是哪个接口，这个接口的具体信息（如功能、协议、URL、请求方法、请求参数说明、响应参数说明等等）可以通过查看开发提供的接口文档获取，也可以通过抓包（在没有接口文档的情况下）获取。找到对应的接口也就是测试对象之后，才能有目的的进行下一步。

1，这里显然是没有接口文档提供接口相关的信息的，我们甚至都不知道请求url，那么先Fiddler抓包获取接口信息。

![acbd0ab9a757ee95a8ad4a8a1c134ff0.png][]

通过抓包我们抓取到了该接口的信息如下：

> 请求url：[https://weathernew.pae.baidu.com/weathernew/pc][https_weathernew.pae.baidu.com_weathernew_pc]
> 
> 请求方式：GET
> 
> 请求参数：

2，抓取到以上这些接口信息后，我们先编写简单的脚本请求该接口，如下：

url = "https://weathernew.pae.baidu.com/weathernew/pc"
    params = {
    	"query": "浙江杭州天气",
    	"srcid": 4982
    }
    res = requests.get(url=url, params=params)
    print(res.status_code)
    print(res.text)

运行代码，接口调试通过，能获取到结果，如下：

![d1b488c61b9570ad787f23aeb03ef6b5.png][]

3，明确需求，确定用例。

我们在针对某个接口做自动化测试时，需要先明确用例需要验证的测试点。有些接口既要进行正向的校验，也要进行异常的校验，而有些接口可能在自动化时只需要进行正向校验就够了，无需做异常校验。

我们来分析一下示例的这个天气查询接口，主要有两个测试点：

*  正向请求：输入存在的城市，能查找对应城市的天气
 *  异常请求：输入不存在的城市，提示错误

### 二，编写测试用例 ###

编写测试用例时，我们需要将代码进行封装，可以封装成测试类/方法、测试函数。pytest中对用例封装的命名方式有要求。

至于封装成类还是函数，其实没什么特定的要求，一般`同一个场景`或`同一个测试点相关的接口`可以定义成一个类。

同时用例还需要设置断言，用于校验返回内容是否为期望的内容。**测试用例一定要进行断言，否则毫无意义**。

#### 构造请求数据 ####

正向请求，数据如下：

params = {
    	"query": "浙江杭州天气",
        "srcid": 4982
    }

异常请求，数据如下：

params = {
    	"query": "微信公众号：软件测试凡哥",
        "srcid": 4982
    }

正向请求的结果我们在上面调试请求该接口的时候已经拿到了，如上面的截图。

我们来看下异常请求的结果，为后续设置断言做准备，结果如下：

![46539b48b2713b4e23004e4897fc7afa.png][]

发送异常请求后，返回的code也是200，结果中会出现`暂未开通此城市查询`，且没有出现正向请求中的`window.tplData`内容。

#### 封装测试代码 ####

这里是针对同一个接口的两条不同的测试用例，我们直接封装一个测试类，专门用于测试该接口。示例代码如下：

class TestWeather:
        '''
        校验百度天气查询接口：https://weathernew.pae.baidu.com/weathernew/pc
        '''
    
        def test_get_weather_normal(self):
            '''正向校验-查询存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "浙江杭州天气",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)
    
    
        def test_get_weather_error(self):
            '''异常校验-查询不存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "微信公众号：软件测试凡哥",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)

注意，代码里还没有进行断言，不能算是完整的用例。这里我只是为了说明流程而把断言放到下一步，分析后再写断言。

#### 断言设置 ####

断言，即校验结果是否是我们期望的内容。设置断言时，我们需要先明确校验哪些字段。一般而言，接口响应的code都需要断言，`status_code == 200`则说明接口请求通了。然后再去断言其他必要字段，从而校验接口功能是否实现。

由上面的结果可知，**正向请求**可以进行如下断言：

# 断言code是否等于200，存在则该断言通过
    assert res.status_code == 200
    
    # 断言结果中是否存在"window.tplData"，存在则该断言通过
    assert "window.tplData" in res.text

由上面的结果可知，**异常请求**可以进行如下断言：

# 断言code是否等于200，存在则该断言通过
    assert res.status_code == 200
    
    # 断言结果中是否存在"window.tplData"，注意这里是不存在则该断言通过
    assert "window.tplData" not in res.text
    
    # 断言结果中是否存在"暂未开通此城市查询"，存在则该断言通过
    assert "暂未开通此城市查询" in res.text

### 三，执行脚本获取测试结果 ###

使用pytest框架管理执行用例时，需要先安装pytest，并在模块中import，不清楚的同学可以留言评论区给我，这里就不做过多说明了。

完整示例代码如下：

import requests
    import pytest
    
    
    class TestWeather:
        '''
        校验百度天气查询接口：https://weathernew.pae.baidu.com/weathernew/pc
        '''
    
        def test_get_weather_normal(self):
            '''正向校验-查询存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "浙江杭州天气",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)
            # print(res.status_code)
            # print(res.text)
            assert res.status_code == 200
            assert "window.tplData" in res.text
    
    
        def test_get_weather_error(self):
            '''异常校验-查询不存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "微信公众号：软件测试凡哥",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)
            print(res.status_code)
            print(res.text)
            assert res.status_code == 200
            assert "window.tplData" not in res.text
            assert "暂未开通此城市查询" in res.text
    
            
    if __name__ == '__main__':
        # 使用pytest执行用例
        pytest.main()

当然，这里因为url是共用的，我们最好是将它提取出来，而不是每个测试方法都去定义一次这个变量，如下图所示：

![e6eeae8f49c529d39aaadb09bf611de3.png][]

执行结果如下：

![1b07ccb788503778d5751b2a46357e14.png][]

### 四，总结 ###

单个接口自动化测试用例，我们可以按照上面的步骤来进行，即 明确测试对象-->编写测试用例-->编写测试脚本-->执行脚本、获取测试结果。通过这些步骤，我们便对自动化用例的编写有了基本的思路（这一点对于我们自动化测试思维的形成很重要），为我们后续的学习实践打下基础。

事实上使用编程语言对项目进行自动化测试时，几乎不可能只存在一条测试用例，那么在有多条测试用例的情况下，需要怎样管理用例、执行用例、获取测试结果？这就是单元测试框架需要解决的问题。

### 写在最后 ###

这篇贴子到这里就结束了，最后，希望看这篇帖子的朋友能够有所收获。

都到这了记得三连支持一下吧。

\-------------------------------------------------

完整版文档下载方式：

这些资料，对于从事【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！以上均可以分享。

![2c3d341d54844c5a8b370611817e9c1f.png][]

在评论区和我互动交流或者私❤我【软件测试学习】领取即可，拿走不谢。

[071be6599dc2005d1bd858ece28a01db.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e9dc8769114247248c3629e075457a53.png
[acbd0ab9a757ee95a8ad4a8a1c134ff0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/d6240f39bcea4ad9a09b76642b0f419e.png
[https_weathernew.pae.baidu.com_weathernew_pc]: https://weathernew.pae.baidu.com/weathernew/pc
[d1b488c61b9570ad787f23aeb03ef6b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/a8745f8377314e16bbbaba64a1ad4028.png
[46539b48b2713b4e23004e4897fc7afa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/27de716a491a4bf5b3f6e7996d641d4f.png
[e6eeae8f49c529d39aaadb09bf611de3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/00b9c78c38e6488bbfd12f6206d268b9.png
[1b07ccb788503778d5751b2a46357e14.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/96c6feb15265412687904f7297397358.png
[2c3d341d54844c5a8b370611817e9c1f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/700efcd4980441b39b4027d372c5ff1c.png