RESTful API 是构建 Web 应用程序的一种重要方式。它使用 HTTP 协议中的 GET、POST、PUT 和 DELETE 方法来访问 Web 资源，并使用 JSON 或 XML 数据格式来交换信息。在本篇文章中，我们将学习如何使用 Express.js 实现 RESTful API，包括定义资源路径、处理 HTTP 请求和响应、错误处理和测试方法。
定义资源路径
在实现 RESTful API 之前，我们需要定义所需资源的路径。对于普通的 Web 应用程序，资源路径通常由视图或模板决定。但是，对于 RESTful API，资源路径应该使用基于名称的 URL，并且应该遵循以下模式：
-------- -------------
例如，GET /users 表示获取所有用户列表，GET /users/1 表示获取 ID 为 1 的用户信息，PUT /users/1 表示修改 ID 为 1 的用户信息，并且 DELETE /users/1 表示删除 ID 为 1 的用户信息。根据这种模式，我们可以定义所有所需资源的路径。
处理HTTP请求和响应
在定义了资源路径之后，我们需要编写代码来处理 HTTP 请求并生成响应。在 Express.js 中，我们可以使用 req 对象来获取请求信息，res 对象来生成响应信息。例如，我们可以使用以下代码响应 GET /users 请求：
----------------- ------------- ---- - ------------- --- -------- ---
在这里，我们使用 app.get() 函数来定义 GET /users 资源路径，并将函数作为回调参数传递。当有 GET /users 请求时，该函数将接收 req 和 res 参数，并使用 res.send() 函数响应字符串 Get all users。
同样的，我们可以使用以下代码响应 GET /users/1 请求：
--------------------- ------------- ---- - ------------- ---- ---- -- - - --------------- ---
注意这里我们使用了冒号（:）声明路由参数，这个参数将会被动态地传递。获取路由参数的方式是调用 req.params 对象的属性，如上述的 id 属性。这样，请求 GET /users/1 会返回 Get user with ID 1 的响应。
类似的，我们还可以使用 app.post()、app.put() 和 app.delete() 等方法响应 POST、PUT 和 DELETE 请求。当接收到 POST 请求时，我们可以使用 req.body 属性来获取请求体中的数据。例如，在 POST /users 请求中，req.body 可以包含查找和创建用户所需的数据。在对请求进行处理后，我们可以使用 res.status() 函数设置 HTTP 状态码，然后使用 res.json() 函数来返回 JSON 数据格式的响应。
错误处理
在处理 RESTful API 请求时，可能会发生错误或异常。在这种情况下，我们应该向客户端发送合适的 HTTP 错误码，并根据错误类型返回合适的错误信息。例如，当找不到用户 ID 时，我们可以发送 404 Not Found 错误，当请求无效时，我们可以发送 400 Bad Request 错误。为了处理 RESTful API 的错误，我们可以使用 Express.js 自带的错误处理中间件。
例如，当请求 URL 不匹配任何路由时，我们可以使用以下代码处理 404 错误：
--------------------- ---- ----- - ------------------------- -------- ---
在这里，我们使用 app.use() 函数将一个函数作为错误处理中间件注册。这个函数接收 req、res 和 next 参数。当中间件函数没有调用 next() 函数时，Express.js 会将该函数视为一个错误处理中间件，并在发生错误时调用它。在这个例子中，当请求的 URL 不匹配任何路由时，该函数将发送 404 Not Found 错误信息。
测试方法
当实现了 RESTful API 后，我们需要进行测试以确保它的正确性和可靠性。为了测试 RESTful API，我们可以使用 curl、Postman 等工具，或编写测试脚本来发送 HTTP 请求并验证响应。
例如，我们可以使用以下代码测试 GET /users 资源：
--- ------- - ---------------------
--- - ------------------
------------- -------- ---------- -
----------- ---- ---- ---------- - ---- -- --- ------- -------------- -
------------
--------------
-------------- -------------------
----------------------- -------
------------ ------
---
---在这里，我们使用 supertest 模块和 mocha 测试框架编写了一个测试脚本。该脚本发送一个 GET /users 请求，并验证返回的 JSON 响应是否正确。在测试中，我们使用 expect() 函数检查 HTTP 状态码和响应类型，使用 done() 函数标记测试的结束。
结论
在本篇文章中，我们学习了如何使用 Express.js 实现 RESTful API，并了解了如何定义资源路径、处理 HTTP 请求和响应、错误处理和测试方法。当构建 Web 应用程序时，RESTful API 是一种非常实用的方式，因为它可以提高 Web 应用程序的交互性和可扩展性。我们希望这篇文章可以帮助您了解如何实现 RESTful API，并对您在应用中的实践有所启示。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6710d5b2ad1e889fe2fc4c0d