Chai.js 如何测试 API 返回的数据-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常需要测试 API 返回的数据是否符合我们的预期。这时候，Chai.js 就是一个非常好用的工具。Chai.js 是一个 BDD/TDD 风格的断言库，可以用来编写易读易懂的测试代码。

本文将介绍 Chai.js 的基本用法，以及如何使用 Chai.js 测试 API 返回的数据。

Chai.js 的基本用法

Chai.js 提供了三种断言风格：assert、expect 和 should。下面分别介绍这三种风格的基本用法。

assert 风格

assert 风格是最简单的一种风格，使用 assert 函数进行断言。

const assert = require('chai').assert;

assert.equal(1 + 1, 2);

上面的代码中，assert.equal 函数接受两个参数，第一个参数是实际值，第二个参数是期望值。如果实际值等于期望值，断言通过，否则断言失败。

expect 风格

expect 风格是一种链式语法，使用 expect 函数进行断言。

const expect = require('chai').expect;

expect(1 + 1).to.equal(2);

上面的代码中，expect 函数接受一个参数，表示实际值。然后可以使用 to 属性和一系列的断言方法进行断言。

should 风格

should 风格是一种链式语法，使用 should 函数进行断言。

const should = require('chai').should();

(1 + 1).should.equal(2);

上面的代码中，should 函数会将 Object.prototype 对象的 should 属性设置为一个包含一系列断言方法的对象。然后可以使用这些方法进行断言。

使用 Chai.js 测试 API 返回的数据

假设我们有一个返回用户信息的 API，返回的数据格式如下：

{
  "name": "Tom",
  "age": 20,
  "email": "tom@example.com"
}

我们想要测试这个 API 是否返回了正确的数据。下面是使用 Chai.js 进行测试的代码：

// javascriptcn.com 代码示例
const expect = require('chai').expect;
const axios = require('axios');

describe('API', function() {
  it('should return user info', async function() {
    const response = await axios.get('/api/user');
    expect(response.status).to.equal(200);
    expect(response.data).to.deep.equal({
      name: 'Tom',
      age: 20,
      email: 'tom@example.com'
    });
  });
});

上面的代码中，我们使用 describe 函数定义一个测试套件，使用 it 函数定义一个测试用例。在测试用例中，我们使用 axios 库发送一个 GET 请求，获取 API 返回的数据。然后使用 expect 函数进行断言，判断返回的数据是否符合预期。

其中，expect(response.status).to.equal(200) 断言返回的状态码是否为 200，expect(response.data).to.deep.equal({...}) 断言返回的数据是否深度相等。

总结

Chai.js 是一个非常好用的断言库，可以帮助我们编写易读易懂的测试代码。在测试 API 返回的数据时，我们可以使用 Chai.js 进行断言，判断返回的数据是否符合预期。

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