python如何测试api

Python测试API的方法包括：使用requests库进行手动请求、利用unittest框架进行自动化测试、使用pytest进行更高级的测试、以及结合mock库模拟API响应等。其中，利用requests库是最基础的方法，可以手动发送HTTP请求，验证API的响应。而unittest框架是Python自带的单元测试框架，方便编写测试用例和组织测试流程。pytest相比unittest提供了更简洁的语法和更强大的功能，适合进行复杂的测试。mock库则用于模拟API的响应，特别是在测试中不希望实际调用API时非常有用。接下来，我们将详细探讨这些方法。

一、使用REQUESTS库进行API测试

Requests是Python中一个简单而强大的HTTP库，专门用于发送HTTP请求。通过requests库，我们可以轻松地进行GET、POST、PUT、DELETE等各种HTTP请求，以此来测试API的功能和响应。

发送GET请求

GET请求是最常见的一种HTTP请求，用于从服务器获取数据。使用requests库发送GET请求非常简单：

import requests
response = requests.get('https://api.example.com/data')
print(response.status_code)
print(response.json())

在上述代码中，requests.get()方法用于发送GET请求。我们可以通过response.status_code获取响应状态码，通过response.json()获取响应的JSON数据。

发送POST请求

POST请求通常用于向服务器提交数据。我们可以在POST请求中使用data参数提交表单数据，或使用json参数提交JSON数据：

import requests
payload = {'key1': 'value1', 'key2': 'value2'}
response = requests.post('https://api.example.com/create', json=payload)
print(response.status_code)
print(response.json())

在此示例中，requests.post()方法用于发送POST请求，而json=payload用于指定要发送的JSON数据。

其他请求类型

除了GET和POST，requests库还支持PUT、DELETE等其他HTTP请求类型。这些请求类型的用法与GET和POST类似，只需调用对应的方法即可：

# PUT请求
response = requests.put('https://api.example.com/update/1', json=payload)
DELETE请求
response = requests.delete('https://api.example.com/delete/1')

二、使用UNITTEST框架进行API测试

unittest是Python自带的单元测试框架，提供了丰富的功能来编写和组织测试用例，非常适合进行API测试。

编写测试用例

在unittest框架中，测试用例被定义为一个类，该类继承自unittest.TestCase。在类中，我们可以定义若干个以test_开头的方法，每个方法即为一个测试用例：

import unittest
import requests
class APITestCase(unittest.TestCase):
    def test_get_data(self):
        response = requests.get('https://api.example.com/data')
        self.assertEqual(response.status_code, 200)
        self.assertIn('key', response.json())
    def test_create_data(self):
        payload = {'key': 'value'}
        response = requests.post('https://api.example.com/create', json=payload)
        self.assertEqual(response.status_code, 201)
        self.assertIn('id', response.json())
if __name__ == '__main__':
    unittest.main()

运行测试

要运行测试，只需在终端中执行该脚本。unittest会自动发现并运行所有以test_开头的方法，并输出测试结果。

三、使用PYTEST进行高级API测试

pytest是一个功能强大的测试框架，提供了更简洁的语法和更强大的功能，相较于unittest，它更适合进行复杂的API测试。

编写测试用例

在pytest中，测试用例通常被定义为以test_开头的函数：

import requests
def test_get_data():
    response = requests.get('https://api.example.com/data')
    assert response.status_code == 200
    assert 'key' in response.json()
def test_create_data():
    payload = {'key': 'value'}
    response = requests.post('https://api.example.com/create', json=payload)
    assert response.status_code == 201
    assert 'id' in response.json()

运行测试

要运行pytest测试，只需在终端中进入测试文件所在的目录，并运行pytest命令。pytest会自动发现并运行所有以test_开头的函数。

使用fixture

pytest的一个强大特性是fixture，它用于提供测试用例所需的外部资源，例如数据库连接、测试数据等。fixture可以通过装饰器@pytest.fixture来定义：

import pytest
import requests
@pytest.fixture
def api_base_url():
    return 'https://api.example.com'
def test_get_data(api_base_url):
    response = requests.get(f'{api_base_url}/data')
    assert response.status_code == 200
    assert 'key' in response.json()

四、结合MOCK库模拟API响应

在某些情况下，我们可能不希望在测试中实际调用API，例如API的请求次数有限，或调用API会产生副作用。此时，可以使用mock库来模拟API的响应。

使用mock库

mock库是unittest的一个子模块，提供了模拟对象和方法的功能。在API测试中，我们可以利用mock库来模拟requests库的响应：

import unittest
from unittest.mock import patch
import requests
class APITestCase(unittest.TestCase):
    @patch('requests.get')
    def test_get_data(self, mock_get):
        mock_get.return_value.status_code = 200
        mock_get.return_value.json.return_value = {'key': 'value'}
        response = requests.get('https://api.example.com/data')
        self.assertEqual(response.status_code, 200)
        self.assertIn('key', response.json())
if __name__ == '__main__':
    unittest.main()