使用 Postman / Apifox 调试接口与 Node.js 接口自动化测试
🎯 引言
学完这篇文章,你能用 Postman 或 Apifox 检查接口,再用自动化测试验证响应状态和数据。
🛠 手动调试实际接口
运行路由篇的 routing-server.mjs,在 Postman 或 Apifox 创建请求,方法选 GET,地址填 http://127.0.0.1:3000/users,发送后应看到状态 200 和用户数组。
不能只看“发送成功”,还要核对状态、响应头和正文。连接失败与服务器返回 404 是不同结果,前者可能没有到达接口。
📋 参数放在对应位置
| 要发送的数据 | 工具中的位置 | 示例 |
|---|---|---|
| 用户 ID | URL 路径 | /users/7 |
| 查询条件 | Query | name=小明 |
| JSON 数据 | Body 的 JSON/raw 模式 | name 字段 |
| 正文格式 | Content-Type 头 | application/json |
| 访问凭据 | Authorization 头 | Bearer 后接真实令牌 |
| 文件 | Body 的 form-data 模式 | file 字段选择文件 |
测试 Body 时,停止路由服务,运行请求解析篇的 request-server.mjs。向 /users 提交 {"name":"小明"},应返回相同 JSON;把 name 改成数字,得到 400。
工具可能保存了之前的 Cookie,验证未登录场景时应清理它们。桌面工具不执行浏览器的 CORS 限制,跨域问题仍需在实际页面中验证。
🧰 用 Supertest 请求 Express 应用
Supertest 可以直接请求 Express 应用并断言状态、头部和正文,适合接口测试。安装本节需要的依赖:
npm install --save-dev supertest@7.3.1
Node.js 自带测试运行器 node:test。新建 api.test.mjs,导入路由篇的应用:
import test from 'node:test';
import assert from 'node:assert/strict';
import request from 'supertest';
import { app } from './routing-app.mjs';
routing-app.mjs 只定义路由,没有监听固定端口。Supertest 会为测试安排临时 HTTP 服务,测试结束后关闭。
✅ 检查成功响应
添加一个测试:
test('返回公开用户列表', async () => {
const response = await request(app).get('/users').expect(200);
assert.deepEqual(response.body, { data: [{ id: 1, name: '小明' }] });
});
expect(200) 检查 HTTP 状态,deepEqual 检查完整正文。断言就是把预期写成检查条件,不符合时测试失败。多返回密码字段等内部数据,也会让这里的正文检查失败。
🛑 检查未匹配路由
继续添加:
test('未知接口返回 404', async () => {
const response = await request(app).get('/missing').expect(404);
assert.equal(response.body.error, '接口不存在');
});
这项测试确保未知地址没有被错误地处理成成功。实际业务还应覆盖参数错误、未登录、无权限等分支。
🧾 检查 JSON 解析失败
导入统一异常篇的 error-app.mjs,检查格式错误:
import { app as errorApp } from './error-app.mjs';
test('错误 JSON 返回明确错误码', async () => {
const response = await request(errorApp).post('/users')
.set('Content-Type', 'application/json').send('{').expect(400);
assert.equal(response.body.error.code, 'INVALID_JSON');
});
请求发出了不完整 JSON,解析中间件拒绝后由错误处理中间件返回 400。测试验证的是调用者实际看到的结果。
🚀 运行并确认测试能发现问题
在示例目录运行:
node --test api.test.mjs
应有三项通过。临时将用户列表接口的状态改为 201,再执行,第一项应失败;随后恢复代码。这能确认测试确实在检查预期状态。
涉及数据库的测试使用独立测试库和可清理数据;邮件、支付等外部操作使用服务商测试环境或可控替身,不向真实用户发送。测试命令失败会返回非零退出码,自动发布流程可以据此停止。
❓ 知识问答
Q1:测试必须占用 3000 端口吗?
不需要,Supertest 请求导出的应用时可以使用临时端口。
Q2:只检查请求没抛错够吗?
不够,还需检查状态和正文,HTTP 失败响应也可能正常到达客户端。
Q3:测试通过就说明部署也正常吗?
还需检查部署环境的配置、数据库连接和反向代理,测试只覆盖已写明的场景。
🧪 小练习
给 /health 增加测试,检查 200 和 status 为 ok;再给错误应用添加内部异常返回 500 的测试。
// 请在这里编写代码
