--- name: api-interface-testing description: 按项目规范执行接口测试,包含获取 Token、使用 curl 调用接口及验证要点。在开发或修改接口、需要验证接口行为或用户提及接口测试时使用。 --- # 接口测试 ## 何时使用 - 新增或修改了后端 API,需要验证接口行为 - 用户明确要求进行接口测试或提供测试示例 - 提交代码前确认接口符合「必须测试」规范 ## 测试流程 1. **获取 Token**:先调用登录接口拿到 `data.token` 2. **调用目标接口**:请求头带上 `Authorization: {data.token}` 3. **验证结果**:按下方清单检查返回值与行为 ## 获取 Token - **地址**:`POST /api/oauth/Login` - **Content-Type**:`application/x-www-form-urlencoded` - **参数**:`userName=admin`,`password=123456` - **Base URL**:本地一般为 `http://localhost:19001`,以实际运行环境为准 **curl 示例:** ```bash curl -X POST "http://localhost:19001/api/oauth/Login" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "userName=admin&password=123456" ``` **返回说明**:`data.token` 已包含 `"Bearer "` 前缀,请求其他接口时**直接使用**:`Authorization: {data.token}`(无需再拼 Bearer)。 ## 调用接口示例 **GET(项目规范:GET 使用 data 传参,不用 params):** ```bash curl -X GET "http://localhost:19001/api/xxx/YourAction?key=value" \ -H "Authorization: " ``` **POST(JSON body):** ```bash curl -X POST "http://localhost:19001/api/xxx/YourAction" \ -H "Authorization: " \ -H "Content-Type: application/json" \ -d '{"key":"value"}' ``` 将 `` 替换为登录响应里 `data.token` 的整段字符串(已含 `Bearer `)。 ## 验证清单 测试时需覆盖并确认: - [ ] **功能**:用真实/合理数据调用,返回符合接口约定 - [ ] **正确性**:关键字段类型、取值、分页与业务逻辑一致 - [ ] **边界**:空列表、无数据、参数缺省等处理正确 - [ ] **异常**:非法参数、未登录等返回合理错误码与提示 - [ ] **性能**:响应时间可接受,无超时或明显卡顿 只有测试通过后再提交相关代码。 ## 工具 可使用 curl、Postman、Swagger 等;给出示例时优先提供 **curl**,便于在终端直接执行。