在前端开发中，测试一直是十分重要的一个环节。而测 RESTful API 接口这个过程，在使用 Mocha 这个测试框架的情况下是十分容易的。本文将介绍如何使用 Mocha 测试 RESTful API 接口，并附上示例代码及深入的讲解。
Mocha 简介
Mocha 是一个 JavaScript 测试框架，既可以运行在浏览器端，也可以运行在 Node.js 环境中。它具有简单易用、灵活性强、插件极度丰富等特点，是 Node.js 生态圈内最常用的测试库之一。
RESTful API 接口
RESTful API 是一种基于 HTTP 协议的 Web API 格式，它规范了客户端与服务器之间交互的一些规则。一般有以下几个特点：
- 使用 HTTP 协议，方便跨语言和平台。
- 使用标准的 HTTP 方法（例如 GET、POST、PUT、DELETE）进行操作。
- 返回结果一般为 JSON 格式数据。
- 路径设计简洁、易于理解。
测试 RESTful API
在 Mocha 中测试 RESTful API 分为以下几个环节：
- 建立一个测试框架，在其中注册所需的插件。
- 通过编写测试用例进行 API 的测试，其中会对 API 的请求和响应进行检测。
- 在测试用例中对 API 的返回结果进行处理和比较，从而验证 API 的正确性。
Mocha 示例代码
下面我们将以一个简单的 RESTful API 接口为例，来演示如何使用 Mocha 进行接口测试。
以下是一个 node.js 的实例代码，实现了一条 /api/add 接口，接受两个参数：a 和 b，返回它们的和。
// www.javascriptcn.com code example
const express = require('express')
const bodyParser = require('body-parser')
const app = express()
app.use(bodyParser.urlencoded({ extended: false }))
app.use(bodyParser.json())
app.post('/api/add', (req, res) => {
const { a, b } = req.body
const result = Number(a) + Number(b)
res.json({
code: 200,
message: 'OK',
result
})
})
app.listen(3000, () => {
console.log('Server is up and running at port 3000...')
})接下来我们将使用 Mocha 对这条 API 接口进行测试，首先需要为其引入 supertest 和 assert 库：
npm install supertest assert mocha -D
然后在项目根目录下创建 test 文件夹，并在该目录下创建 api.test.js 文件，编写测试代码如下：
// www.javascriptcn.com code example
const request = require('supertest')
const assert = require('assert')
const app = require('../app')
describe('API Test', () => {
it('should return status code 200', done => {
request(app)
.post('/api/add')
.send({ a: 2, b: 3 })
.expect(200)
.end(done)
})
it('should return the correct result', done => {
request(app)
.post('/api/add')
.send({ a: 2, b: 3 })
.end((err, res) => {
if (err) done(err)
assert.strictEqual(res.body.code, 200)
assert.strictEqual(res.body.result, 5)
done()
})
})
})以上代码的操作分为两个部分：
- 第一个测试用例是测试 HTTP 状态码是否为 200。
- 第二个测试用例是测试返回结果是否正确。
上述两种测试方法都依赖于 supertest 库。第一种测试方法通过检测返回的 HTTP 状态码是否为 200 来验证接口是否成功调用，而第二种测试方法则需要对返回的 JSON 对象进行验证。
结尾
Mocha 是一个十分强大且灵活的 JavaScript 测试库，通过学会掌握其使用方法，可以提高代码质量和稳定性。本文已经完成了一个完整的 RESTful API 测试示例，希望能够对读者的工作有所启发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d63efea941bf7134bf10e2