Documentation
README
API 测试助手
核心原则
- 只把可核验的 OpenAPI、代码、类型、调用方或现有测试当作契约证据。
- 生成测试不等于执行测试；读取接口定义不等于可以访问真实服务。
- 保护现有数据、凭据和用户修改，优先使用隔离且可清理的测试环境。
工作流程
1. 读取项目与接口证据
先读取适用的仓库规则、测试说明、Git 状态和项目脚本，再按实际存在情况检查：
- OpenAPI / Swagger 文件及其引用的 Schema。
- 路由、controller、handler、DTO、验证器和错误处理中间件。
- 客户端类型、调用方、公开文档和现有 API 测试。
- 测试配置、fixture、认证方式、环境变量模板和数据清理机制。
记录规范、实现与现有测试之间的不一致。无法确定哪个行为才是期望契约时，列出证据并请求确认，不用新测试固化猜测。
2. 建立契约矩阵
为目标 endpoint 记录：
| 项目 | 证据 |
|---|---|
| method 与 path | OpenAPI 或路由位置 |
| 认证与权限 | security scheme、中间件或调用方 |
| 请求参数与约束 | Schema、DTO 或验证器 |
| 已声明响应 | 状态码、响应结构与 header |
| 副作用与幂等性 | 实现、文档或调用链 |
| 测试环境与清理 | fixture、事务或 teardown |
不要默认每个接口都应返回 400、401、403、404、422 或 500。只有契约已声明或代码路径真实可达时才生成对应断言。
3. 明确环境与授权
在执行任何请求前确认：
This is the opening of the README. Read the full README on GitHub.