如何用Jest为含复杂内部逻辑的REST API编写单元测试？

核心思路 #

由于chooseTheFeature逻辑复杂且涉及外部资源（文件、大型机、数据库），我们的测试目标聚焦在**MyAPI自身的逻辑正确性**：即调用chooseTheFeature成功/失败时，是否返回符合预期的HTTP响应。核心手段是完全MockchooseTheFeature，避免触发任何真实业务逻辑。

步骤分解与代码实现 #

1. Mock目标函数 #

因为chooseTheFeature和MyAPI在同一模块，我们通过Jest的模块Mock能力，替换掉原函数为模拟函数，以此控制它的执行结果（成功resolve或失败reject）。

2. 模拟Express请求/响应对象 #

Express的API依赖req、res参数，我们用Jest的模拟函数（mock functions）创建这些对象，用来捕获status和json方法的调用情况，验证响应是否符合预期。

完整测试用例示例 #

假设你的API文件名为api.js，测试文件命名为api.test.js：

const { MyAPI } = require('./api');

// Mock模块内的chooseTheFeature函数，保留其他导出内容
jest.mock('./api', () => {
  const original = jest.requireActual('./api');
  return {
    ...original,
    chooseTheFeature: jest.fn(),
  };
});

// 导入被Mock后的chooseTheFeature
const { chooseTheFeature } = require('./api');

describe('MyAPI接口测试', () => {
  // 每次测试前重置Mock状态，避免用例间污染
  beforeEach(() => {
    jest.clearAllMocks();
  });

  test('业务逻辑执行成功时，返回200状态与成功消息', async () => {
    // 模拟请求对象，携带测试用的请求体
    const req = { body: { featureId: 'test-123' } };
    // 模拟响应对象，链式调用需要mockReturnThis()维持上下文
    const res = {
      status: jest.fn().mockReturnThis(),
      json: jest.fn(),
    };
    const next = jest.fn();

    // 设置Mock函数执行成功
    chooseTheFeature.mockResolvedValue();

    await MyAPI(req, res, next);

    // 验证chooseTheFeature被正确调用，参数为请求体
    expect(chooseTheFeature).toHaveBeenCalledWith(req.body);
    // 验证响应状态码为200
    expect(res.status).toHaveBeenCalledWith(200);
    // 验证响应JSON内容正确
    expect(res.json).toHaveBeenCalledWith({ message: "All went well!" });
    // 验证错误处理中间件next未被调用
    expect(next).not.toHaveBeenCalled();
  });

  test('业务逻辑执行失败时，返回400状态与错误消息', async () => {
    const req = { body: { featureId: 'invalid-456' } };
    const res = {
      status: jest.fn().mockReturnThis(),
      json: jest.fn(),
    };
    const next = jest.fn();

    // 设置Mock函数抛出错误
    const testError = new Error('模拟业务逻辑错误');
    chooseTheFeature.mockRejectedValue(testError);

    await MyAPI(req, res, next);

    expect(chooseTheFeature).toHaveBeenCalledWith(req.body);
    expect(res.status).toHaveBeenCalledWith(400);
    expect(res.json).toHaveBeenCalledWith({ message: "Something went wrong!" });
    expect(next).not.toHaveBeenCalled();
  });
});

额外注意点 #

• 单元测试的边界是当前模块，chooseTheFeature的内部逻辑需要单独编写单元测试（同样Mock它的所有外部依赖），不要在MyAPI的测试中混入对它的验证。
• 如果chooseTheFeature是从外部模块导入的，只需调整Mock目标为对应模块即可，比如jest.mock('../services/featureService')。
• 链式调用模拟：res.status().json()需要mockReturnThis()来保证调用status()后返回res对象本身，否则会报错无法调用json()。

内容的提问来源于stack exchange，提问作者NodeFriend