Chai-Http 框架中 expect.header 详解

如果你正在开发一个 Node.js 的应用并且要写一些接口测试，那么你一定会用到 Chai-Http 这个框架。它是一个方便的工具，可以用来测试 Node.js 应用的 HTTP 接口。其中一个常用的断言方法是 expect.header，用来对接口返回的头信息进行验证。本文将详解 expect.header 的用法以及其指导意义。

一、expect.header 的语法

expect.header 的语法如下所示：

expect(res).to.have.header(property, [,value]);

其中，

• res：由 chai-http 包装后返回的 HTTP 请求响应对象。
• property：表示 HTTP 头中的属性名称。
• value：可选参数，表示 HTTP 头中属性的值。

二、使用 expect.header 进行 HTTP 头验证

假设我们使用了 Chai-Http 发送了一个 HTTP 请求，并且将其响应保存到了 res 中。现在我们需要验证响应的 HTTP 头中是否包含了某个属性，该怎么办呢？我们可以使用 expect.header。比如我们要验证响应的 Header 中是否有 Content-Type 这个属性，用法如下：

// 假设已经发送了 HTTP 请求并保存了响应

expect(res).to.have.header('Content-Type');

通过这个断言方法，我们就可以验证该属性是否存在于响应头信息中。

如果我们想验证某个属性的具体值，可以使用第二个可选参数，如下所示：

// 假设已经发送了 HTTP 请求并保存了响应

expect(res).to.have.header('Content-Type', 'application/json; charset=utf-8');

通过这个断言方法，我们就可以验证响应头信息中具有指定属性和属性值。

此外，我们还可以使用 expect.headers 断言方法来验证多个 HTTP 头信息。比如我们想要验证响应头信息中包含了 Content-Type 和 Cache-Control 两个属性，用法如下：

// 假设已经发送了 HTTP 请求并保存了响应

expect(res).to.have.headers('content-type', 'cache-control');

expect.headers 可以接收一个以上的参数，用来传递多个属性名称。如果想要验证每个属性的具体值，则需要使用 to.have.deep.headers。

三、优化测试代码

对单元测试的代码量进行优化是非常重要的。下面提供一种使用 chai-as-promised（chai-http 的扩展之一）增强测试代码的方法。代码可以被重构如下：

const chai = require('chai');
const chaiAsPromised = require('chai-as-promised');
const chaiHttp = require('chai-http');

chai.use(chaiAsPromised);
chai.use(chaiHttp);

const expect = chai.expect;

describe('APIs Test', function () {
  let res;
  const url = 'https://jsonplaceholder.typicode.com/todos/1';

  before('sending request', async function () {
    res = await chai.request(url).get('');
  });

  it('should have the right content type in the response header', function () {
    return expect(res).to.have.header('content-type', 'application/json; charset=utf-8');
  });

  it('should have a successful status code', function () {
    expect(res).to.have.status(200);
  });

});

四、总结

本文详细介绍了 Chai-Http 框架中的 expect.header 断言方法。通过本文，你可以了解到该方法的使用方法及其指导意义，同时也提供了优化测试代码的方法，希望能够帮助你在接口测试中提高工作效率。

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