Python自动化实战 | 使用Pytest进行API测试 【干货】

每次手动测试API都需要重复输入相同的数据，而且还需要跑多个测试用例，十分繁琐和无聊。那么，有没有一种方法可以让你更高效地测试API呢？Pytest自动化测试！今天，小编将向你介绍如何使用Pytest进行API自动化测试。

什么是API测试？

API测试是一种软件测试方法，用于测试应用程序编程接口（API）以确保其功能、可靠性、性能和安全性。与其他类型的软件测试不同，API测试主要关注的是API的功能和性能，而不是整个应用程序的功能和性能。API测试可以帮助开发人员和测试人员快速准确地测试API，从而提高开发效率和软件质量。

Pytest框架

Pytest是一个流行的Python测试框架，用于编写和运行测试。Pytest具有简单易用的语法，可以轻松地编写各种类型的测试，包括单元测试、集成测试和API测试。Pytest还提供了许多有用的功能，例如自动发现测试、测试重复、测试过滤和测试报告。

使用Pytest进行API测试

下面，我将向你演示如何使用Pytest框架进行API测试。我将以测试一个简单的API为例，该API接受两个数字并返回它们的和。我们将编写一个测试用例来测试该API。

首先，我们需要安装Pytest框架。在终端中输入以下命令即可安装Pytest：

pip install pytest

我们需要编写一个测试用例。在这个测试用例中，我们将使用Python的requests库来向API发送请求，并使用断言来验证API的响应是否正确。以下是测试用例的源代码：

1. import requests

3. def test_addition():

4.     url = "http://localhost:5000/add"

5.     data = {"num1": 2, "num2": 3}

6.     response = requests.post(url, data=data)

7.     assert response.status_code == 200

8.     assert response.json() == {"result": 5}

在上面的代码中，我们首先定义了一个名为test_addition的测试函数。该函数使用requests库向API发送POST请求，并将两个数字作为输入数据。然后，我们使用两个断言来验证API的响应是否正确。第一个断言验证响应的状态码是否为200，而第二个断言验证响应的JSON数据是否为{"result": 5}。

现在，我们可以使用Pytest来运行这个测试用例了。在终端中输入以下命令即可运行测试：

pytest test_api.py

如果一切正常，Pytest将输出测试结果，并告诉你测试是否通过。如果测试失败，Pytest将显示失败的测试用例和错误信息。

高级用法

1. 参数化测试

在进行测试时，我们经常需要对不同的输入数据进行测试。如果我们使用传统的测试方式，就需要编写多个测试用例。但是使用pytest的参数化测试功能，我们可以通过一些参数，来自动生成多个测试用例。这样就可以大大减少我们的代码量，提高测试效率。

下面是一个示例，我们使用参数化测试来测试一个计算器函数的多组输入输出。

1. import pytest

3. @pytest.mark.parametrize("a,b,expected", [

4.     (1, 2, 3),

5.     (2, 3, 5),

6.     (3, 4, 7),

7. ])

8. def test_add(a, b, expected):

9.     assert a + b == expected

在这个示例中，我们使用pytest.mark.parametrize装饰器来指定参数化测试的参数。在参数化的列表中，每一组参数都是一个元组，元组中包含了函数的参数以及期望的输出值。pytest会自动将这些参数组合成多个测试用例，并依次执行。

2. Fixture的使用

在进行测试时，我们经常需要创建一些测试数据或者测试环境，这时我们可以使用pytest的Fixture功能。Fixture是一个可以提供测试数据或者测试环境的函数，我们可以在测试用例中通过装饰器来使用它。

下面是一个示例，我们使用Fixture来创建一个测试环境，然后进行测试。

1. import pytest

3. @pytest.fixture

4. def setup_environment():

5.     # 创建测试环境

6.     env = {'name': 'test'}

7.     yield env

8.     # 清理测试环境

9.     del env

11. def test_env(setup_environment):

12.     assert setup_environment['name'] == 'test'

在这个示例中，我们使用@pytest.fixture装饰器来定义setup_environment函数为Fixture。在这个函数中，我们可以创建测试环境，并在yield语句中返回它。在测试用例中，我们可以通过参数名来使用Fixture，pytest会自动将Fixture的返回值传递给测试用例。

3. 自定义插件

pytest有很多自带的插件，可以帮助我们完成一些常见的测试任务。但是在实际使用中，我们往往需要更多的功能。这时，我们可以使用pytest的插件机制，来自定义插件，以满足我们的需求。

下面是一个示例，我们使用pytest的插件机制，来自定义一个插件，用于在测试用例执行前输出一些信息。

1. import pytest

3. @pytest.hookimpl(tryfirst=True)

4. def pytest_runtest_logstart(nodeid):

5.     print(f"Running test {nodeid}...")

7. def test_example():

8.     assert 1 + 1 == 2

在这个示例中，我们使用@pytest.hookimpl装饰器来定义pytest_runtest_logstart函数为插件。在这个函数中，我们输出了测试用例的ID。在测试用例执行前，pytest会自动调用这个插件，并输出信息。

技术总结

本文介绍了API测试的概念，并详细介绍了如何使用Pytest框架进行API测试。我希望这篇文章能帮助你更好地理解API测试和如何使用Python自动化测试来提高测试效率和软件质量。同时，我也希望你能够通过这个例子和Pytest框架的简单介绍，学习到如何编写和运行API测试用例。

 

感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取