在现代 web 开发中，RESTful API 已经成为了一个非常流行的 API 设计风格。通过使用 RESTful API，我们可以轻松地对数据进行 CRUD 操作，并以标准化的方式进行数据交互。在这篇文章中，我们将讨论如何使用 Node.js 和 Express.js 构建 RESTful API 并进行测试。
Node.js 和 Express.js 简介
Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行时，它允许我们使用 JavaScript 来开发服务器端应用程序。Node.js 常用于构建高性能的网络应用程序，并且具有轻量级、高效、易于扩展等优点。
Express.js 是一个基于 Node.js 的 web 框架。它提供了一组强大的功能，包括路由、模板引擎、中间件等。通过使用 Express.js，我们可以快速地构建一个 RESTful API。
RESTful API 的基本要素
RESTful API 应当具有以下特征：
- 无状态：每个请求必须包含足够的信息来理解请求的目的和如何响应请求。
- 统一接口：客户端和服务器之间的通信应该使用一组统一的接口，这些接口定义了资源的请求方式和表示形式。
- 可缓存性：响应应该能够被缓存，以提高性能。
- 分层系统：客户端不应该知道与其交互的后端系统的结构，即客户端和服务器之间的关系应该是分层的。
- 按需代码：客户端应该能够下载并执行只与当前需要的功能相关的代码。
使用 Node.js 和 Express.js 构建 RESTful API
要构建一个 RESTful API，我们需要定义资源的 URI 和使用 HTTP 动词来操作资源。具体来说，我们需要使用以下 HTTP 动词：
- GET：获取资源的信息。
- POST：创建资源。
- PUT：更新资源。
- DELETE：删除资源。
接下来，我们将通过一个示例来演示如何使用 Node.js 和 Express.js 构建一个 RESTful API。
首先，我们需要安装并引入 Express.js 模块：
const express = require('express');
const app = express();接下来，我们需要定义我们的路由。我们可以使用 Express.js 提供的路由方法。例如，以下代码定义了一个处理 /users 路径的 GET 请求的路由：
app.get('/users', (req, res) => {
// 处理 GET /users 请求
});我们还可以使用 POST、PUT、DELETE 等 HTTP 动词定义其他的路由处理器。
接下来，我们需要定义我们的 RESTful API。对于我们的 API，我们将定义一个 users 资源，其 URI 为 /users。我们还将使用一个内存数据存储来存储我们的用户。以下代码定义了我们的 users API：
-- -------------------- ---- -------
--- ----- - ---
-- ------
----------------- ----- ---- -- -
----------------
---
-- ------
------------------ ----- ---- -- -
----- ---- - -
----- --------------
---- -------------
------ ---------------
--
-----------------
-------------- ------- ---------------
---
-- ------
------------------------- ----- ---- -- -
----- ------ - ------------------
----- ---- - ------------ -- ---- --- --------
-- ------ -
---------------
- ---- -
-------------- --- --------
-
---
-- ------
------------------------- ----- ---- -- -
----- ------ - ------------------
----- --------- - ----------------- -- ---- --- --------
-- ---------- -- -- -
--------------------- - --------------
-------------------- - -------------
---------------------- - ---------------
-------------- ------- ---------------
- ---- -
-------------- --- --------
-
---
-- ------
---------------------------- ----- ---- -- -
----- ------ - ------------------
----- --------- - ----------------- -- ---- --- --------
-- ---------- -- -- -
----------------------- ---
-------------- ------- ---------------
- ---- -
-------------- --- --------
-
---在上面的代码中，我们定义了以下路由：
- GET /users：获取所有用户。
- POST /users：创建一个用户。
- GET /users/:userId：获取一个用户。
- PUT /users/:userId：更新一个用户。
- DELETE /users/:userId：删除一个用户。
测试 RESTful API
测试 RESTful API 可以帮助开发人员检测错误、评估性能、确保 API 按照规范工作等。以下是一些我们可以使用的 RESTful API 测试工具：
- Postman：一款功能强大的测试工具，可以对 RESTful API 进行测试、调试和修复。
- curl：一个命令行工具，可以发送 HTTP 请求进行测试。
- Fiddler：一个类似于 Postman 的界面，但是它也提供了其他一些功能，例如自动检测跨站点脚本攻击（XSS）和跨站点请求伪造（CSRF）。
在使用这些工具测试 RESTful API 之前，我们需要确保我们的服务器已经运行。我们可以使用以下命令启动我们的服务器：
app.listen(3000, () => {
console.log('Server is listening on port 3000');
});结论
在本文中，我们了解了 RESTful API 的基本要素，并使用 Node.js 和 Express.js 构建了一个 RESTful API。我们还简要介绍了一些可供使用的 RESTful API 测试工具。随着 web 应用程序的不断发展，RESTful API 的重要性越来越明显。通过了解构建和测试 RESTful API 的基础知识，您可以更好地设计和构建您的服务器端应用程序，并为您的应用程序提供更好的用户体验。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66ef1f0f6fbf9601972e1432