请解释如何测试 GraphQL API？

推荐答案

测试 GraphQL API 的步骤

1. 使用 GraphQL Playground 或 GraphiQL
   这些工具提供了一个交互式的界面，允许你编写和执行 GraphQL 查询。你可以直接在浏览器中测试 API，查看返回的数据和错误信息。

2. 编写单元测试
   使用测试框架（如 Jest 或 Mocha）编写单元测试，模拟 GraphQL 查询和变更操作。你可以使用 graphql-tools 来创建模拟的 schema 和 resolvers，并验证返回的数据是否符合预期。

3. 集成测试
   使用工具（如 Supertest）对 GraphQL API 进行集成测试。你可以发送 HTTP 请求到 API 端点，并验证响应状态码、返回的数据结构以及错误处理。

4. 自动化测试
   将测试集成到 CI/CD 管道中，确保每次代码变更后都能自动运行测试。可以使用工具（如 GitHub Actions 或 Jenkins）来实现自动化测试。

5. 性能测试
   使用工具（如 Artillery 或 k6）对 GraphQL API 进行性能测试，确保在高负载下 API 的响应时间和吞吐量符合预期。

本题详细解读

1. 使用 GraphQL Playground 或 GraphiQL

GraphQL Playground 和 GraphiQL 是两种常用的工具，用于在浏览器中测试 GraphQL API。它们提供了一个交互式的界面，允许你编写和执行 GraphQL 查询、变更和订阅操作。你可以直接查看返回的数据、错误信息以及执行时间。

• GraphQL Playground：支持多标签页、自动补全、查询历史记录等功能，适合复杂的测试场景。
• GraphiQL：轻量级工具，适合简单的查询测试。

2. 编写单元测试

单元测试是测试 GraphQL API 的基础。你可以使用 Jest 或 Mocha 等测试框架来编写测试用例。通过 graphql-tools，你可以创建模拟的 schema 和 resolvers，并验证返回的数据是否符合预期。

// www.javascriptcn.com code example
const { graphql } = require('graphql');
const { makeExecutableSchema } = require('graphql-tools');

const typeDefs = `
  type Query {
    hello: String
  }
`;

const resolvers = {
  Query: {
    hello: () => 'Hello, world!',
  },
};

const schema = makeExecutableSchema({ typeDefs, resolvers });

test('hello query returns "Hello, world!"', async () => {
  const query = '{ hello }';
  const result = await graphql(schema, query);
  expect(result.data.hello).toBe('Hello, world!');
});

3. 集成测试

集成测试用于验证整个 API 的行为是否符合预期。你可以使用 Supertest 等工具发送 HTTP 请求到 GraphQL API 端点，并验证响应状态码、返回的数据结构以及错误处理。

// www.javascriptcn.com code example
const request = require('supertest');
const app = require('../app'); // 假设你的 Express 应用在 app.js 中

test('GET /graphql returns hello world', async () => {
  const response = await request(app)
    .post('/graphql')
    .send({ query: '{ hello }' })
    .set('Accept', 'application/json');

  expect(response.statusCode).toBe(200);
  expect(response.body.data.hello).toBe('Hello, world!');
});

4. 自动化测试

自动化测试是确保代码质量的重要手段。你可以将测试集成到 CI/CD 管道中，确保每次代码变更后都能自动运行测试。常用的工具包括 GitHub Actions、Jenkins 等。

// www.javascriptcn.com code example
# .github/workflows/ci.yml
name: CI

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'
      - run: npm install
      - run: npm test

5. 性能测试

性能测试用于验证 GraphQL API 在高负载下的表现。你可以使用 Artillery 或 k6 等工具来模拟大量并发请求，并监控 API 的响应时间和吞吐量。

// www.javascriptcn.com code example
# artillery.yml
config:
  target: "http://localhost:4000"
  phases:
    - duration: 60
      arrivalRate: 10
scenarios:
  - flow:
      - post:
          url: "/graphql"
          json:
            query: "{ hello }"

// www.javascriptcn.com code example
// k6 script
import http from 'k6/http';
import { check, sleep } from 'k6';

export default function () {
  const res = http.post('http://localhost:4000/graphql', JSON.stringify({ query: '{ hello }' }), {
    headers: { 'Content-Type': 'application/json' },
  });
  check(res, { 'status was 200': (r) => r.status == 200 });
  sleep(1);
}