如果你是前端工程师，那么你很可能需要与后端程序员合作，共同开发一个完整的 Web 应用程序。在这个过程中，RESTful API 是一个必不可少的组成部分。在本文中，我们将使用 Express.js 来创建一个简单的 RESTful API。
RESTful API 介绍
RESTful API 同时具有结构明确、易于扩展和维护的优点，是现代 Web 应用程序的关键组件。RESTful API 使用 HTTP 协议作为通信协议，并且遵循一组约定和标准，以便于与各种客户端和服务端通信，从而实现 Web 应用程序的各种功能。
RESTful API 是 Stateless 的，表示每次请求都是独立的，服务器不会存储任何关于客户端的状态信息。而是通过 URL 和参数来维护请求的状态。
什么是 Express.js
Express.js 是一个基于 Node.js 构建的 Web 框架，是一个极其灵活和易于管理的框架。使用 Express.js 创建 RESTful API 时，可以方便地处理 HTTP 请求和响应，以及实现路由、中间件等常见功能。
创建 RESTful API
下面是使用 Express.js 创建 RESTful API 的基本步骤：
步骤 1：安装和配置
在开始之前，需要确保已经安装了 Node.js 和 npm。如果没有，请先安装。
在命令行中，进入项目目录，使用 npm 安装 Express.js 模块，执行以下命令：
--- ------- ------- ------
使用 --save 参数将 Express.js 添加到项目的依赖中。
步骤 2：设置路由
使用 Express.js 常见的功能之一是路由。路由用于指定 URL 和 HTTP 请求方法之间的映射关系。
在 Express.js 中，路由由一个或多个中间件组成，每个中间件都负责处理特定的路由。
下面是一个基本的路由示例代码：
----- ------- - ------------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- -------- --- ---------------- -- -- - ---------------- --------- -- ---- ------- ---
在这个例子中，我们创建了一个路由，并定义了路由的根路径 /。当客户端发送 GET 请求时，Express.js 应用程序将返回文本 Hello World!。
步骤 3：添加 RESTful API
接下来，我们将在 Express.js 应用程序中添加一个简单的 RESTful API。
HTTP 方法
RESTful API 支持以下 HTTP 请求方法：
- GET：从服务器检索资源。
- POST：向服务器创建新的资源。
- PUT：向服务器更新现有资源。
- DELETE：从服务器删除资源。
API 路径
每个 API 都需要定义一个 URL 路径，用于标识该 API。在 Express.js 中，可以使用 express.Router() 方法来定义路由。下面是一个简单的例子：
----- ------- - ------------------- ----- ------ - ----------------- -- ------ --------------- ----- ---- -- - ------------- -------- --- -- ---- -------------- - -------
在这个例子中，我们定义了一个基本路由 /，并导出该路由，以便在应用程序中使用。
定义 API 路径
可以使用路由对象的 get()、post()、put() 和 delete() 方法来定义每个 API 的路径和相应的操作。例如，下面是定义一个简单的 API 的示例：
----- ------- - ------------------- ----- ------ - ----------------- -- -- --- -- --------------- ----- ---- -- - ------------- -------- --- -------------------- ----- ---- -- - ------------- ----- -------- --- -- ---- -------------- - -------
在这个例子中，我们定义了两个 API，分别为 / 和 /users。
API 响应
RESTful API 的响应通常是 JSON 格式的数据。在 Express.js 应用程序中，可以使用 response.json() 方法来发送 JSON 响应。例如，下面是定义一个简单的 API 并返回 JSON 响应的示例：
----- ------- - ------------------- ----- ------ - ----------------- -- -- --- -- --------------- ----- ---- -- - ------------- -------- --- -------------------- ----- ---- -- - ----- ----- - -- ----- ------- -- - ----- ----- --- ---------------- --- -- ---- -------------- - -------
在这个例子中，我们返回了一个包含两个用户对象的 JSON 响应。
总结
在本文中，我们介绍了 RESTful API 的基本概念和 Express.js 的优点，并提供了一些示例代码，以帮助你开始构建自己的 RESTful API。需要注意的是，这只是一个简单的例子，你可以根据自己的需求对 API 进行改进。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6649916bd3423812e486f9a8