# 接口自动化测试 **Repository Path**: Estrella_H/interface-automation-testing ## Basic Information - **Project Name**: 接口自动化测试 - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-09-16 - **Last Updated**: 2026-09-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # REST/JSON 接口自动化测试 基于 Python、pytest、requests、PyYAML、Allure 和可选 PyMySQL 的接口自动化项目。YAML 负责测试数据和预期结果,Python 负责接口封装与业务流程。 当前包含 RuoYi-Vue 3.9.2 的认证、用户、角色、菜单、部门、岗位、字典、参数配置、通知公告和权限流程用例。通用能力与若依业务代码分开,替换 `api/`、`services/`、`data/cases/` 和业务 Repository 后,可以用于其他 REST/JSON 项目。 ## 分层 ```text config/ 公共配置、本地敏感配置及配置校验 core/ HTTP、异常和测试资源清理 api/ 单接口对象,仅封装路径和请求方式 services/ 登录和跨接口业务流程 assertions/ 公共响应断言和数据库断言 database/ 通用 MySQL 客户端与业务 Repository data/cases/ YAML 测试数据和预期结果 utils/ YAML 加载和运行时变量替换 tests/api/ 直接调用 API Object 的单接口测试 tests/workflows/ 调用 Service / Flow 的跨模块业务流程测试 unit_tests/ 框架公共能力单元测试 ``` 单接口测试的调用方向为: ```text Tests -> API Object -> HttpClient ``` 跨接口流程的调用方向为: ```text Tests -> Service / Flow -> API Object -> HttpClient ``` Service 只用于确实需要组合多个接口的业务动作。单接口测试不会为了分层而经过 Service。业务 SQL 只能放在 `database/repositories/`。 ## 各层职责 - Tests:展示测试场景、API 调用和关键断言,允许适度重复。 - Service / Flow:组合多个 API,并传递上下游接口产生的数据。 - API Object:维护接口路径、请求方法和参数,不做业务断言或数据库操作。 - HttpClient:统一处理地址、Session、Bearer Token、超时、日志和请求异常。 - Assertions:只保留响应和数据库结果中真正重复的公共断言。 - Fixtures:只初始化客户端、登录、接口对象、流程对象和数据库连接。 - Utils:只包含无业务属性的 YAML 加载和变量替换工具。 ## 配置 公共默认值位于 `config/config.yaml`。密码等敏感信息放在被 Git 忽略的 `config/config.local.yaml`,可从 `config/config.local.example.yaml` 复制。 支持以下环境变量覆盖: ```text API_BASE_URL API_TIMEOUT API_USERNAME API_PASSWORD MYSQL_HOST MYSQL_PORT MYSQL_DATABASE MYSQL_USERNAME MYSQL_PASSWORD ``` `database.enabled=false` 时,带 `database` 标记的用例会跳过,其他接口用例仍可执行。 ## 执行 ```powershell python -m pytest python -m pytest -m api python -m pytest -m workflow python -m pytest -m database python -m pytest -m "not database" python -m pytest unit_tests ``` pytest 会先清理旧结果,再把新的 Allure 原始结果写入 `reports/allure-results`。需要 HTML 报告时执行: ```powershell allure generate reports/allure-results --clean -o reports/allure-report ``` ## YAML 测试数据 每个业务模块都有一份已经生成好的完整测试数据,例如用户数据位于 `data/cases/user.yaml`。后续新增或修改用例时,测试人员直接编辑对应 YAML 中的 `request` 和 `expected` 即可,不需要修改随机数据生成代码。 普通单接口用例使用固定数据,不再自动生成 UUID、用户名、手机号等内容。执行前应保证 YAML 中需要唯一的名称、编码、手机号和邮箱没有被其他环境数据占用。框架会在测试结束后自动清理本次创建的数据,因此推荐串行执行同一套固定数据。 YAML 节点可以是单个对象,也可以扩展为对象列表: ```yaml create: - id: create_success request: userName: "at_manual_user_001" nickName: "AT测试用户001" expected: http_status: 200 code: 200 ``` 只有接口之间真实产生的依赖数据才使用占位符,例如创建角色时使用上一步菜单接口产生的 `${menu_id}`。登录账号和密码使用配置中的 `${username}`、`${password}`,避免把敏感信息写入测试数据。接口路径和请求方法放在 `api/`。YAML 只保存测试输入和预期结果;接口调用、条件判断和跨接口流程继续使用易读的 Python 代码表达,不在 YAML 中执行动态代码。 ## 数据库与清理 - 只有明确添加 `@pytest.mark.database` 的用例才允许使用 `db` fixture。 - MySQLClient 只提供连接和通用查询;业务表查询及硬清理位于 Repository。 - 单接口用例明确调用新增接口;创建成功后,通过一个简单辅助函数定位资源 ID 并登记清理。 - 数据库用例可额外登记硬清理,普通 API 用例不依赖数据库权限。 - 跨接口 Flow 按依赖顺序创建和删除资源,Tests 层显式展示主要业务阶段。 - 请求、响应和 Allure 附件会隐藏密码、Token 和 Authorization 等敏感字段。 完整测试范围见 [docs/test_matrix.md](docs/test_matrix.md)。