Skip to content

About

An extensible API test automation framework built with Python, Pytest, Requests, OpenAPI, Allure, and CI. Supports data-driven testing, token management, contract validation, database checks, and smoke/regression execution.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

Pytest API Automation Practice

这是一个基于 Python、Pytest 和 Requests 的接口自动化学习项目。仓库内置 FastAPI 服务 Juestore,用于稳定复现登录、用户、权限、商品、订单、上传、 Token、幂等性和 OpenAPI 契约等测试场景,无需依赖不可控的公共接口。

Juestore 只销售虚构的虚拟商品,例如测试游戏账户、平台余额兑换码和会员兑换码。 仓库中不包含任何真实账号、兑换码或支付能力。

环境准备

项目使用 Python 3.11 和 uv 管理环境:

uv sync

首次同步会根据 pyproject.toml 和 uv.lock 创建 .venv 并安装依赖。

启动 Juestore

uv run python main.py

默认地址:

  • API:http://127.0.0.1:8000
  • Swagger UI:http://127.0.0.1:8000/docs
  • OpenAPI:http://127.0.0.1:8000/openapi.json
  • 健康检查:http://127.0.0.1:8000/health

也可以使用 Uvicorn 的热更新模式:

uv run uvicorn juestore.main:app --reload --host 127.0.0.1 --port 8000

固定测试数据

用户名 密码 角色或状态 用途
admin 123456 管理员 用户和商品管理、权限测试
buyer 123456 普通买家 查询商品和订单链路
disabled 123456 已禁用 登录异常测试
locked 123456 已锁定 登录异常测试

固定商品:

  • 1001:正常销售、库存充足的游戏账户商品。
  • 1002:正常销售、库存为 1 的余额兑换码。
  • 1003:已下架的会员兑换码。

测试买家的虚拟收货配置为 address_id=88。

核心接口

方法 路径 用途
POST /api/login 登录并返回 access/refresh token,同时设置 Cookie
POST /api/auth/refresh 刷新 Token
POST /api/logout 清除登录 Cookie
GET /api/userinfo 查询当前用户
GET/POST/PATCH/DELETE /api/users/... 用户和权限练习
GET/POST/PATCH /api/products/... 商品查询与管理员维护
GET/POST /api/orders/... 创建、查询和取消订单
POST /api/upload 文件上传练习

所有业务响应使用统一结构:

{
  "code": 0,
  "message": "success",
  "data": {},
  "meta": null
}

HTTP 状态码遵循 RESTful 规则,例如认证失败返回 401、无权限返回 403、 资源不存在返回 404、业务冲突返回 409、参数校验失败返回 422。

curl 示例

登录:

curl -X POST http://127.0.0.1:8000/api/login -H "Content-Type: application/json" -d "{\"username\":\"buyer\",\"password\":\"123456\"}"

查询商品:

curl "http://127.0.0.1:8000/api/products?page=1&size=10&keyword=code"

创建订单时,将登录响应中的 data.token 替换到下面的命令中:

curl -X POST http://127.0.0.1:8000/api/orders -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" -d "{\"product_id\":1001,\"count\":1,\"address_id\":88,\"request_id\":\"practice-001\"}"

运行测试

完整测试无需手动启动 Juestore。session fixture 会在随机本地端口启动真实 Uvicorn 服务,使用临时 SQLite 数据库,并在测试结束后关闭服务和清理数据。

uv run pytest
uv run pytest -m smoke
uv run pytest -m contract
uv run pytest -m "not integration"
uv run pytest tests/test_login.py -v

DeepSeek 用例标记为 integration。未配置 DEEPSEEK_API_KEY 时会自动跳过, 默认执行也会排除外部集成测试,不会影响本地 Juestore 测试。需要显式验证时运行:

uv run pytest -m integration

测试模式会额外开放 POST /api/test/reset。普通开发模式不会注册此接口,避免误清数据。

配置

可用环境变量记录在 .env.example:

  • JUESTORE_DATABASE_URL:默认 sqlite:///./.local/juestore.db
  • JUESTORE_JWT_SECRET:JWT 密钥,建议至少 32 个随机字符
  • JUESTORE_ACCESS_TOKEN_MINUTES:access token 有效期
  • JUESTORE_REFRESH_TOKEN_HOURS:refresh token 有效期
  • JUESTORE_UPLOAD_DIR:上传文件目录
  • JUESTORE_HOST、JUESTORE_PORT:手动启动地址和端口

.env、SQLite 数据库和上传文件均已加入 .gitignore,不要提交真实密钥。

后续学习路线

  1. 用 YAML/JSON 管理登录和订单用例。
  2. 封装统一 ApiClient、公共断言、变量提取和替换。
  3. 使用 Schemathesis 根据 /openapi.json 生成契约和异常用例。
  4. 集成日志、Allure 和 JUnit XML 报告。
  5. 将 SQLite 替换为 Docker MySQL,并增加数据库断言。
  6. 接入 GitHub Actions 或 Jenkins 执行冒烟与回归测试。

About

An extensible API test automation framework built with Python, Pytest, Requests, OpenAPI, Allure, and CI. Supports data-driven testing, token management, contract validation, database checks, and smoke/regression execution.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages