如何在 Mocha 测试中使用 supertest 测试 RESTful API？

在前端开发中，测试是非常重要的一环。尤其是在开发 RESTful API 的过程中，我们需要对 API 进行测试以确保其可靠性和正确性。在本篇文章中，我会详细介绍如何在 Mocha 测试中使用 supertest 来测试 RESTful API。

supertest 简介

supertest 是一个流行的 Node.js 测试工具，它可以帮助我们编写简单的、可靠的 API 测试。它可以轻松地与 Mocha 这样的测试框架集成。使用 supertest，我们可以轻松地模拟 HTTP 请求，测试我们的 API 是否按照预期进行响应。

安装和使用

首先，我们需要安装 supertest。可以使用以下命令：

npm install supertest --save-dev

然后，我们需要在 Mocha 测试代码中引入 supertest 模块。这里是一个简单的示例：

const request = require('supertest');
const app = require('../app');

describe('GET /users', () => {
  it('responds with 200', (done) => {
    request(app)
      .get('/users')
      .expect(200, done);
  });
});

在上面的示例中，我们首先引入了 supertest 模块并创建了一个 app 实例。然后，我们使用 describe() 和 it() 方法来编写测试用例。在 it() 中，我们使用 supertest 发送一个 GET 请求到 /users 路径，并确保它返回一个 200 状态码。

进一步测试

除了简单的 API 调用之外，supertest 还支持许多其他操作，例如发送 POST、PUT 和 DELETE 请求，添加请求头，设置 cookie 等。以下是一些示例：

describe('POST /users', () => {
  it('creates a user', (done) => {
    const user = { name: 'John Doe', email: 'john@example.com' };
    request(app)
      .post('/users')
      .send(user)
      .set('Accept', 'application/json')
      .expect('Content-Type', /json/)
      .expect(201)
      .end((err, res) => {
        if (err) return done(err);
        expect(res.body.name).to.equal('John Doe');
        done();
      });
  });
});

describe('PUT /users/:id', () => {
  it('updates a user', (done) => {
    const user = { name: 'John Doe', email: 'john@example.com' };
    request(app)
      .put('/users/1')
      .send(user)
      .set('Accept', 'application/json')
      .expect('Content-Type', /json/)
      .expect(200, done);
  });
});

describe('DELETE /users/:id', () => {
  it('deletes a user', (done) => {
    request(app)
      .delete('/users/1')
      .expect(204, done);
  });
});

在上述示例中，我们分别测试了 POST、PUT 和 DELETE 请求。注意，我们使用了 expect() 方法检查响应是否符合我们的预期，并使用 end() 回调函数处理响应和错误。此外，我们还使用了 set() 方法添加请求头，以及 send() 方法添加请求正文（如果需要的话）。

总结

在本文中，我们学习了如何在 Mocha 测试中使用 supertest 来测试 RESTful API。通过 supertest，我们可以编写简单的、可靠的 API 测试，并确保我们的 API 按照预期进行响应。如果你正在开发 RESTful API，那么加入 supertest 将是一个非常好的决定。

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