在 Mocha 测试框架中使用 SuperTest 测试 GraphQL API

前言

GraphQL 是一种新兴的 API 构建方式，它通过一个查询语言，让前端开发者能够精确地获取需要的数据。不同于传统的 RESTful API，GraphQL 能够一次性发送多个请求，这极大地提高了应用程序的效率。

在开发过程中，我们需要保证 GraphQL API 的正确性和稳定性。这就需要使用测试框架对 GraphQL API 进行测试。Mocha 是一个 Javascript 测试框架，它提供了一组优秀的工具和 API，方便我们编写测试用例。而 SuperTest 则是一个优秀的 HTTP 断言库，能够用于测试任何 HTTP API，包括 GraphQL API。

本文将介绍如何在 Mocha 测试框架中使用 SuperTest 测试 GraphQL API，并演示如何编写测试用例。

安装 Mocha 和 SuperTest

首先，我们需要安装 Mocha 和 SuperTest。可以使用以下命令安装它们：

npm install --save-dev mocha supertest

编写测试用例

接下来，我将向你展示如何编写测试用例。假设我们有一个 GraphQL API，它可以 返回一个特定 ID 的用户。它的查询语句如下：

query {
  user(id: "1") {
    id
    name
    email
  }
}

我们需要检查 API 是否返回正确的用户数据。我们可以使用 SuperTest 来模拟 HTTP 请求并获取响应数据，再使用 Mocha 来进行断言。

以下是示例代码：

const supertest = require('supertest');
const app = require('../app'); // 你的 GraphQL API 的入口文件
const request = supertest(app);

describe('测试 GraphQL API', () => {
  it('获取用户数据', (done) => {
    request
      .post('/graphql')
      .send({ query: '{ user(id: "1") { id name email } }' })
      .end((err, res) => {
        if (err) return done(err);
        const user = res.body.data.user;
        assert.equal(user.id, "1");
        assert.equal(user.name, "张三");
        assert.equal(user.email, "zhangsan@gmail.com");
        done();
      });
  });
});

在上面的代码中，我们首先使用 supertest 创建了一个 HTTP 请求，然后使用 Mocha 的 describe 和 it 函数来描述测试用例。在测试用例中，我们使用 request 对象来发送 GraphQL 查询语句，并检查 API 是否返回正确的数据。

总结

在本文中，我们介绍了如何在 Mocha 测试框架中使用 SuperTest 来测试 GraphQL API。我们通过编写测试用例来演示了测试的过程，并展示了如何使用 SuperTest 进行 HTTP 请求以及如何在 Mocha 中进行断言。对于开发者来说，这些测试能够保证 GraphQL API 的正确性和稳定性，并增加代码的可维护性。

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