企业级接口自动化框架结构详解 笔记

"""
企业级接口自动化框架结构详解
一，完整目录结构
api-automation/
├── core/             # 框架核心引擎（灵魂）
├── utils/            # 通用工具类
├── api/              # 接口对象层（企业高级用法）
├── data/             # 测试数据
├── config/           # 配置文件
├── testcase/         # 测试用例
├── report/           # 测试报告（自动生成）
├── logs/             # 日志文件（自动生成）
├── conftest.py       # pytest 全局钩子
├── pytest.ini        # pytest 配置
├── run.py            # 一键启动入口
└── requirements.txt   # 依赖清单
二，目录详解
1，core —— 框架核心引擎（最重要）
作用：框架的心脏，所有请求、上下文、异常都在这里
ore/
├── __init__.py
├── session.py       # 请求封装、超时、异常、自动加签
├── context.py       # 上下文（接口关联：token、order_id 传递）
└── exception.py     # 自定义异常

2，utils/ —— 工具类（通用功能）
作用：所有项目都能用的通用工具，与业务无关
utils/
├── __init__.py
├── log_utils.py        # 日志
├── allure_utils.py     # allure 报告
├── yaml_utils.py       # 读取 yaml
├── encrypt_utils.py    # 加密：MD5/HMAC/AES/RSA/JWT
└── assert_utils.py     # 断言工具

3，api/ —— 接口对象层（企业高级分层）
这是企业标准分层思想：接口管理 + 用例分离
api/
├── __init__.py
├── user_api.py     # 用户接口：登录、获取信息
├── order_api.py    # 订单接口：创建、查询
└── pay_api.py      # 支付接口

4，data/ —— 测试数据
作用：数据与代码分离
data/
├── user_data.yaml
├── order_data.yaml
└── config.json

5，config/ —— 全局配置
作用：环境、域名、密钥、超时时间
config/
├── __init__.py
├── env.py         # 多环境：测试/预发/生产
└── setting.py     # 密钥、AES/RSA 配置

6，testcase/ —— 测试用例
作用：只写业务逻辑、断言、场景
testcase/
├── __init__.py
├── test_user.py
├── test_order.py
└── test_pay.py

7，report/ —— 测试报告
自动生成，不用管：
report/
├── allure/
└── html/

8，logs/ —— 日志文件
自动生成：
plaintext
logs/
└── 2026-03-30.log

9，根目录文件
conftest.py
全局 fixture：自动登录、token、数据清理
pytest.ini
pytest 配置：用例标记、编码、报告
run.py
项目入口，一键执行用例 + 生成报告
requirements.txt
项目依赖：
pytest
requests
allure-pytest
pycryptodome
pyjwt
pyyaml

三、企业分层逻辑
1. 工具层 → utils
2. 核心层 → core
3. 配置层 → config
4. 接口层 → api
5. 数据层 → data
6. 用例层 → testcase
7. 报告层 → report
"""