Python接口自动化从入门到实战:7个核心代码示例带你构建企业级测试框架

pip install requests pytest pytest-html allure-pytest pyyaml openpyxl

import requestsdef test_get_user():    """GET请求：获取指定用户信息"""    url = "https://jsonplaceholder.typicode.com/users/1"    response = requests.get(url)    # 打印调试信息    print(f"状态码: {response.status_code}")    print(f"响应体: {response.text}")    # 关键断言    assert response.status_code == 200, f"预期200，实际{response.status_code}"    # 解析JSON响应    data = response.json()    assert data["id"] == 1    assert "Leanne Graham" in data["name"]    # 验证响应头    assert response.headers["Content-Type"] == "application/json; charset=utf-8"

import requestsdef test_create_post():    """POST请求：创建一篇新文章"""    url = "https://jsonplaceholder.typicode.com/posts"    payload = {        "title": "Python接口自动化实战",        "body": "这篇内容涵盖了7个核心示例，从GET到报告生成。",        "userId": 99    }    headers = {"Content-Type": "application/json"}    response = requests.post(url, json=payload, headers=headers)    # 验证创建成功（HTTP 201 Created）    assert response.status_code == 201    resp_json = response.json()    assert resp_json["title"] == payload["title"]    assert "id" in resp_json  # 服务端应返回自增ID    # 进阶：验证响应模型（可使用pydantic，但此处从简）    assert isinstance(resp_json["id"], int)

[    {        "name": "正常注册",        "payload": {"username": "alice", "email": "alice@example.com", "age": 25},        "expected_status": 201,        "expected_msg": "success"    },    {        "name": "缺少必填字段email",        "payload": {"username": "bob", "age": 30},        "expected_status": 400,        "expected_msg": "email required"    }]

import pytestimport requestsimport json# 读取测试数据with open("test_data/create_user_cases.json", "r", encoding="utf-8") as f:    test_cases = json.load(f)@pytest.mark.parametrize("case", test_cases, ids=lambda x: x["name"])def test_create_user_data_driven(case):    url = "https://api.example.com/users"  # 替换为真实接口    response = requests.post(url, json=case["payload"])    resp_json = response.json()    assert response.status_code == case["expected_status"]    assert resp_json.get("message") == case["expected_msg"]

class Assertions:    """通用断言类，支持JsonPath、状态码、字段存在性等"""    @staticmethod    def assert_status_code(response, expected_code):        """断言HTTP状态码"""        assert response.status_code == expected_code, \            f"状态码错误: 预期{expected_code}, 实际{response.status_code}"    @staticmethod    def assert_json_value_by_key(response, key, expected_value, key_path=None):        """        断言JSON中某个key的值        :param key_path: 支持点号分隔的嵌套路径，如 "data.user.id"        """        data = response.json()        if key_path:            # 简单实现嵌套取值：data["data"]["user"]["id"]            parts = key_path.split(".")            value = data            for part in parts:                value = value.get(part, {})            actual_value = value.get(key)        else:            actual_value = data.get(key)        assert actual_value == expected_value, \            f"字段 {key_path}.{key if key_path else key} 预期{expected_value}，实际{actual_value}"    @staticmethod    def assert_schema(response, expected_schema):        """使用jsonschema库校验响应结构（需安装jsonschema）"""        from jsonschema import validate        validate(instance=response.json(), schema=expected_schema)# 使用示例def test_login():    response = requests.post("https://api.example.com/login", json={"user": "admin", "pwd": "123"})    Assertions.assert_status_code(response, 200)    Assertions.assert_json_value_by_key(response, "token", exists=True)  # 可扩展存在性断言‍

import requestsclass ApiClient:    def __init__(self, base_url):        self.base_url = base_url        self.session = requests.Session()    def login(self, username, password):        """登录并存储Token或Cookie"""        url = f"{self.base_url}/login"        resp = self.session.post(url, json={"username": username, "password": password})        assert resp.status_code == 200        # 假设服务端返回token，并期望后续请求放在Header中        token = resp.json().get("access_token")        if token:            self.session.headers.update({"Authorization": f"Bearer {token}"})        # 如果使用Cookie，session会自动存储Set-Cookie，无需额外操作        return self    def get_user_info(self, user_id):        url = f"{self.base_url}/users/{user_id}"        return self.session.get(url)    def close(self):        self.session.close()# 测试用例def test_user_flow():    client = ApiClient("https://api.example.com")    client.login("test_user", "pass123")    # 以下请求自动携带认证信息    resp = client.get_user_info(123)    assert resp.status_code == 200    client.close()

import loggingimport requestsimport time# 配置日志格式logging.basicConfig(level=logging.INFO,                     format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')logger = logging.getLogger("APIAutoTest")def log_request(response, request_start_time):    """记录请求耗时及详情"""    elapsed = (time.time() - request_start_time) * 1000  # 转毫秒    req = response.request    logger.info(f"请求方法: {req.method} | URL: {req.url}")    logger.info(f"请求头: {req.headers}")    logger.info(f"请求体: {req.body}")    logger.info(f"响应状态: {response.status_code} | 耗时: {elapsed:.2f}ms")    logger.info(f"响应体: {response.text[:500]}")  # 避免过长截断def test_with_logging():    url = "https://jsonplaceholder.typicode.com/posts/1"    start = time.time()    resp = requests.get(url)    log_request(resp, start)    assert resp.status_code == 200

# 运行命令：pytest test_suite.py --html=report.html --self-contained-html

import allureimport requests@allure.feature("用户模块")@allure.story("获取用户信息")def test_get_user_with_allure():    with allure.step("步骤1：发送GET请求"):        response = requests.get("https://jsonplaceholder.typicode.com/users/1")    with allure.step("步骤2：验证状态码"):        allure.attach(str(response.status_code), name="状态码", attachment_type=allure.attachment_type.TEXT)        assert response.status_code == 200    with allure.step("步骤3：验证关键字段"):        data = response.json()        allure.attach(str(data), name="响应体", attachment_type=allure.attachment_type.JSON)        assert data["id"] == 1# 运行：pytest --alluredir=./allure-results# 生成报告：allure generate ./allure-results -o ./allure-report --clean# 打开报告：allure open ./allure-report

import pytestimport requestsimport yaml@pytest.fixture(scope="session")def config():    """加载全局配置，作用域session只加载一次"""    with open("config.yaml", "r", encoding="utf-8") as f:        return yaml.safe_load(f)@pytest.fixture(scope="session")def api_client(config):    """返回一个已认证的API客户端（同示例5的ApiClient）"""    base_url = config["base_url"]    client = ApiClient(base_url)    client.login(config["default_user"], config["default_password"])    yield client    client.close()# 测试用例直接使用fixturedef test_get_profile(api_client):    resp = api_client.get_user_info(1)    assert resp.status_code == 200配置文件 config.yaml：base_url: https://api.example.comdefault_user: admindefault_password: admin123‍