如何使用pytest进行API测试

使用pytest进行API测试主要涉及以下几个步骤：

1. 安装pytest

首先，确保你已经安装了pytest。你可以使用pip来安装：

pip install pytest

2. 创建测试文件

创建一个Python文件，通常命名为test_api.py或其他你喜欢的名字。

3. 编写测试用例

在测试文件中，编写测试用例。你可以使用requests库来发送HTTP请求。

示例代码

import requests
import pytest

BASE_URL = "https://api.example.com"

def test_get_endpoint():
    response = requests.get(f"{BASE_URL}/endpoint")
    assert response.status_code == 200
    assert "expected_key" in response.json()

def test_post_endpoint():
    payload = {"key": "value"}
    response = requests.post(f"{BASE_URL}/endpoint", json=payload)
    assert response.status_code == 201
    assert response.json()["key"] == "value"

def test_put_endpoint():
    payload = {"key": "new_value"}
    response = requests.put(f"{BASE_URL}/endpoint/1", json=payload)
    assert response.status_code == 200
    assert response.json()["key"] == "new_value"

def test_delete_endpoint():
    response = requests.delete(f"{BASE_URL}/endpoint/1")
    assert response.status_code == 204

4. 使用pytest的fixture

为了使测试更加模块化和可重用，可以使用pytest的fixture功能。

示例代码

import requests
import pytest

BASE_URL = "https://api.example.com"

@pytest.fixture(scope="module")
def session():
    session = requests.Session()
    yield session
    session.close()

def test_get_endpoint(session):
    response = session.get(f"{BASE_URL}/endpoint")
    assert response.status_code == 200
    assert "expected_key" in response.json()

def test_post_endpoint(session):
    payload = {"key": "value"}
    response = session.post(f"{BASE_URL}/endpoint", json=payload)
    assert response.status_code == 201
    assert response.json()["key"] == "value"

5. 运行测试

在命令行中运行pytest来执行测试：

pytest test_api.py

6. 添加更多功能

• 参数化测试：使用@pytest.mark.parametrize装饰器来参数化测试用例。
• Mocking：使用unittest.mock或responses库来模拟HTTP请求和响应。
• 报告生成：使用pytest-html插件生成HTML格式的测试报告。

参数化测试示例

import requests
import pytest

BASE_URL = "https://api.example.com"

@pytest.mark.parametrize("payload, expected_status", [
    ({"key": "value"}, 201),
    ({"key": "another_value"}, 200),
])
def test_post_endpoint(session, payload, expected_status):
    response = session.post(f"{BASE_URL}/endpoint", json=payload)
    assert response.status_code == expected_status

通过这些步骤，你可以使用pytest进行基本的API测试，并根据需要扩展和改进你的测试套件。