Mocha 测试框架：如何使用 supertest 进行 API 测试？

在前端开发中，我们经常需要测试我们的 API 是否符合预期。这时候，就需要使用一种测试框架来进行测试。Mocha 是一个流行的 JavaScript 测试框架，它可以用于测试前端和后端代码。而 supertest 是一个用于测试 Node.js HTTP 服务器的库，它可以与 Mocha 配合使用，提供了一种简单的方式来测试 API。本文将介绍如何使用 supertest 进行 API 测试。

安装

首先，你需要安装 Mocha 和 supertest。你可以使用 npm 来安装它们：

npm install mocha supertest --save-dev

编写测试用例

我们将编写一个简单的测试用例，测试一个 API 是否正确地返回数据。

// javascriptcn.com 代码示例
const request = require('supertest');
const app = require('../app');

describe('API 测试', function() {
  it('获取用户信息', function(done) {
    request(app)
      .get('/user')
      .expect(200)
      .end(function(err, res) {
        if (err) return done(err);
        done();
      });
  });
});

在这个测试用例中，我们使用了 supertest 的 request 方法来发起一个 GET 请求，并期望返回状态码为 200。如果 API 返回了正确的数据，测试就会通过。

运行测试用例

在编写好测试用例后，我们需要运行它们来测试我们的 API。我们可以在命令行中运行以下命令来运行测试用例：

npx mocha test/api.test.js

如果测试用例通过，你将会看到一些类似于以下的输出：

API 测试
  ✓ 获取用户信息


1 passing (50ms)

如果测试用例失败，你将会看到一些类似于以下的输出：

// javascriptcn.com 代码示例
API 测试
  1) 获取用户信息


0 passing (50ms)
1 failing

1) API 测试
     获取用户信息:
   AssertionError: expected 404 to equal 200
    at Test._assertStatus (/path/to/test/api.test.js:8:12)
    at Test._assertFunction (/path/to/test/api.test.js:18:11)
    at Test.assert (/path/to/node_modules/supertest/lib/test.js:162:18)
    at Server.localAssert (/path/to/node_modules/supertest/lib/test.js:131:12)
    at emitCloseNT (net.js:1653:8)
    at processTicksAndRejections (internal/process/task_queues.js:83:21)


0 passing (50ms)
1 failing

总结

在本文中，我们介绍了如何使用 supertest 进行 API 测试。supertest 提供了一种简单的方式来测试 API，而 Mocha 则提供了一个流行的测试框架来组织和运行测试用例。通过使用这些工具，你可以轻松地测试你的 API 是否符合预期，从而提高你的代码质量和可靠性。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6569564dd2f5e1655d1e0cb6