什么是 RESTful API？
REST（Representational State Transfer）是一种架构风格，它的设计思想是在网络中处理资源。RESTful API 是使用 REST 原则实现的 API，它是一种机制，允许两台计算机之间进行互联网通信，使得 Web 应用程序能够使用 HTTP 协议进行交互。
RESTful API 能够提供分布式网络中的服务，它的主要特性是：
每个资源都有一个唯一的标识符（URI）。
使用标准的 HTTP 方法（如 GET、POST、PUT、DELETE）来对资源进行操作。
可以使用不同格式的数据（如 XML、JSON、HTML）来表示资源状态。
所有的请求都是无状态的，即服务器不会存储客户端的请求信息。
使用 Express.js 构建 RESTful API
Express.js 是一个基于 Node.js 平台的 Web 应用程序开发框架，它提供了一组简单易用的 API，使得开发者可以快速构建现代化的 Web 应用程序。以下是使用 Express.js 构建 RESTful API 的步骤。
步骤1：初始化项目
首先，我们需要创建一个新项目。打开终端，进入工作空间目录，并输入以下命令：
mkdir my-api cd my-api npm init -y
这将创建一个名为 my-api 的新项目，并使用默认设置自动生成 package.json。
步骤2：安装 Express.js
在步骤1完成后，我们需要安装 Express.js。在终端中输入以下命令：
npm install express
这将在当前项目中安装 Express.js 并将其添加到 package.json 中的依赖项列表中。
步骤3：创建入口文件
接下来，我们需要创建一个名为 index.js 的入口文件，并将以下代码添加到该文件中：
// javascriptcn.com 代码示例
const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello, World!');
});
app.listen(3000, () => {
console.log('Server started on port 3000');
});这个例子中，我们从 Express.js 库中导入 express 模块。这个模块提供了一个名为 express() 的函数，可以创建一个新的应用程序对象。我们使用这个对象的 get() 方法来定义路由并发送 HTTP 响应。
步骤4：启动服务器
最后，我们可以使用以下命令在本地启动服务器：
node index.js
这将启动一个监听 3000 端口的服务器，可以通过浏览器或其他 HTTP 客户端来访问。
使用 Express.js 实现 RESTful API
上面的例子演示了如何使用 Express.js 在根路径上发送一个消息。实际上，我们可以使用多个 HTTP 方法（get、post、put、delete 等）来定义各种 RESTful API 操作。以下是一个示例，它定义了一组简单的目录服务操作。
// javascriptcn.com 代码示例
const express = require('express');
const app = express();
const directories = [
{ id: 1, name: 'Archive' },
{ id: 2, name: 'Inbox' },
{ id: 3, name: 'Outbox' },
];
app.get('/', (req, res) => {
res.send('Welcome to our directory service!');
});
app.get('/api/directories', (req, res) => {
res.send(directories);
});
app.get('/api/directories/:id', (req, res) => {
const directory = directories.find((d) => d.id === parseInt(req.params.id));
if (!directory) return res.status(404).send('The directory with the given ID was not found.');
res.send(directory);
});
app.post('/api/directories', (req, res) => {
const directory = {
id: directories.length + 1,
name: req.body.name,
};
directories.push(directory);
res.send(directory);
});
app.put('/api/directories/:id', (req, res) => {
const directory = directories.find((d) => d.id === parseInt(req.params.id));
if (!directory) return res.status(404).send('The directory with the given ID was not found.');
directory.name = req.body.name;
res.send(directory);
});
app.delete('/api/directories/:id', (req, res) => {
const directory = directories.find((d) => d.id === parseInt(req.params.id));
if (!directory) return res.status(404).send('The directory with the given ID was not found.');
const index = directories.indexOf(directory);
directories.splice(index, 1);
res.send(directory);
});
app.listen(3000, () => {
console.log('Server started on port 3000');
});这个例子中，我们首先定义一个名为 directories 的数组，它包含了三个目录。接下来，我们使用 get() 方法来定义路由并发送目录列表。使用 :id 表示在路径上定义变量。我们使用 find() 方法来查找目录，并使用 404 状态码来处理找不到的情况。
我们使用 post() 方法来定义创建操作，它会检查并添加新的目录。put() 方法用于更新现有目录的名称。最后，我们使用 delete() 方法来删除我们想要删除的目录。
总结
本文介绍了如何使用 Express.js 构建 RESTful API，并提供了详细的示例代码。我们学习了 RESTful API 的基本概念，以及如何使用 Express.js 实现不同的 HTTP 操作来对资源进行操作。这会对前端工程师和 Web 开发者非常有用。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/654c8ce17d4982a6eb604455