api_auto_test/
├── config/                 # 環(huán)境配置目錄
│   └── config.yaml         # 多環(huán)境配置（開發(fā)/測試/生產(chǎn)）
├── api/                    # 接口封裝層（所有業(yè)務(wù)接口）
│   ├── __init__.py
│   └── login_api.py        # 登錄接口封裝
├── testcases/              # 測試用例層（僅寫用例邏輯）
│   ├── __init__.py
│   └── test_login.py       # 登錄模塊測試用例
├── utils/                  # 工具層（通用方法）
│   ├── __init__.py
│   ├── request_util.py     # HTTP 請求封裝
│   ├── assert_util.py      # 統(tǒng)一斷言工具
│   └── log_util.py         # 日志工具（可選）
├── data/                   # 測試數(shù)據(jù)層（數(shù)據(jù)驅(qū)動）
│   └── login_data.yaml     # 登錄模塊測試數(shù)據(jù)
├── reports/                # 測試報告輸出目錄
├── requirements.txt        # 項目依賴清單
└── pytest.ini              # Pytest 全局配置文件

pip install requests pytest pyyaml allure-pytest

pip freeze > requirements.txt

# 環(huán)境配置：dev-開發(fā)環(huán)境 test-測試環(huán)境 prod-生產(chǎn)環(huán)境
active_env: "test"
env:
  dev:
    base_url: "https://dev-api.example.com"
    timeout: 10
  test:
    base_url: "https://api.example.com"
    timeout: 10
  prod:
    base_url: "https://prod-api.example.com"
    timeout: 15

import requests
import yaml
import logging
from typing import Dict, Any

# 配置日志
logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s - %(levelname)s - %(message)s"
)
logger = logging.getLogger(__name__)

class RequestUtil:
    def __init__(self):
        # 加載配置文件
        with open("../config/config.yaml", "r", encoding="utf-8") as f:
            self.config = yaml.safe_load(f)
        # 獲取當(dāng)前激活的環(huán)境
        self.active_env = self.config["active_env"]
        self.base_url = self.config["env"][self.active_env]["base_url"]
        self.timeout = self.config["env"][self.active_env]["timeout"]

    def send_request(
        self,
        method: str,
        path: str,
        headers: Dict[str, str] = None,
        params: Dict[str, Any] = None,
        json: Dict[str, Any] = None,
        data: Any = None,
        **kwargs
    ) -> requests.Response:
        """
        統(tǒng)一發(fā)送 HTTP 請求
        :param method: 請求方法 GET/POST/PUT/DELETE
        :param path: 接口路徑
        :param headers: 請求頭
        :param params: URL 參數(shù)
        :param json: JSON 格式請求體
        :param data: 表單格式請求體
        :return: 響應(yīng)對象
        """
        url = self.base_url + path
        logger.info(f"請求地址: {method} {url}")
        logger.info(f"請求參數(shù): params={params}, json={json}")

        try:
            resp = requests.request(
                method=method,
                url=url,
                headers=headers,
                params=params,
                json=json,
                data=data,
                timeout=self.timeout,
                **kwargs
            )
            logger.info(f"響應(yīng)狀態(tài)碼: {resp.status_code}")
            logger.info(f"響應(yīng)內(nèi)容: {resp.text[:500]}")  # 只打印前500字符，避免日志過長
            return resp
        except requests.exceptions.Timeout:
            logger.error(f"請求超時: {url}")
            raise
        except requests.exceptions.ConnectionError:
            logger.error(f"連接失敗: {url}")
            raise
        except Exception as e:
            logger.error(f"請求異常: {str(e)}")
            raise

from utils.request_util import RequestUtil

class LoginApi:
    def __init__(self):
        self.request = RequestUtil()

    def login(self, username: str, password: str):
        """
        登錄接口
        :param username: 用戶名
        :param password: 密碼
        :return: 響應(yīng)對象
        """
        path = "/api/v1/login"
        payload = {
            "username": username,
            "password": password
        }
        return self.request.send_request(
            method="POST",
            path=path,
            json=payload
        )

- case_name: 正常登錄-正確用戶名密碼
  username: "test01"
  password: "123456"
  expect_status: 200
  expect_code: 0
  expect_msg: "登錄成功"
- case_name: 登錄失敗-密碼錯誤
  username: "test01"
  password: "wrong123"
  expect_status: 200
  expect_code: 1001
  expect_msg: "密碼錯誤"
- case_name: 登錄失敗-用戶名不存在
  username: "nonexist"
  password: "123456"
  expect_status: 200
  expect_code: 1002
  expect_msg: "用戶不存在"
- case_name: 登錄失敗-用戶名為空
  username: ""
  password: "123456"
  expect_status: 200
  expect_code: 1003
  expect_msg: "用戶名不能為空"

import pytest
import yaml
from api.login_api import LoginApi

# 加載測試數(shù)據(jù)
def load_login_data():
    with open("../data/login_data.yaml", "r", encoding="utf-8") as f:
        return yaml.safe_load(f)

class TestLogin:
    def setup_class(self):
        """測試類執(zhí)行前的初始化操作"""
        self.login_api = LoginApi()

    @pytest.mark.parametrize("case", load_login_data(), ids=[case["case_name"] for case in load_login_data()])
    def test_login_cases(self, case):
        """登錄接口測試用例"""
        # 發(fā)送請求
        resp = self.login_api.login(
            username=case["username"],
            password=case["password"]
        )
        # 斷言
        assert resp.status_code == case["expect_status"]
        assert resp.json()["code"] == case["expect_code"]
        assert case["expect_msg"] in resp.json()["msg"]

import requests
from typing import Any

def assert_status_code(resp: requests.Response, expect_code: int = 200):
    """斷言響應(yīng)狀態(tài)碼"""
    assert resp.status_code == expect_code, f"狀態(tài)碼錯誤，預(yù)期：{expect_code}，實際：{resp.status_code}"

def assert_response_code(resp: requests.Response, expect_code: int = 0):
    """斷言業(yè)務(wù)響應(yīng)碼"""
    assert resp.json()["code"] == expect_code, f"業(yè)務(wù)碼錯誤，預(yù)期：{expect_code}，實際：{resp.json()['code']}"

def assert_response_contains(resp: requests.Response, key: str, value: Any):
    """斷言響應(yīng)體包含指定鍵值對"""
    assert key in resp.json(), f"響應(yīng)體中不存在鍵：{key}"
    assert resp.json()[key] == value, f"鍵值錯誤，預(yù)期：{value}，實際：{resp.json()[key]}"

def assert_response_msg_contains(resp: requests.Response, expect_msg: str):
    """斷言響應(yīng)消息包含指定內(nèi)容"""
    assert expect_msg in resp.json()["msg"], f"響應(yīng)消息不包含：{expect_msg}，實際：{resp.json()['msg']}"

pytest -v

# 執(zhí)行測試并生成 Allure 原始數(shù)據(jù)
pytest -v --alluredir=reports/allure-results

# 啟動本地服務(wù)查看報告
allure serve reports/allure-results

# 生成靜態(tài) HTML 報告（可部署到服務(wù)器）
allure generate reports/allure-results -o reports/allure-report --clean

[pytest]
# 默認(rèn)命令行參數(shù)：-s 輸出print信息 --tb=short 簡化錯誤堆棧
addopts = -s --tb=short --alluredir=reports/allure-results
# 指定測試用例搜索路徑
testpaths = testcases
# 指定測試文件命名規(guī)則
python_files = test_*.py
# 指定測試類命名規(guī)則
python_classes = Test*
# 指定測試方法命名規(guī)則
python_functions = test_*
# 標(biāo)記用例（用于分組執(zhí)行）
markers =
    smoke: 冒煙測試用例
    regression: 回歸測試用例