在现代网络开发中，RESTful API 已经成为构建被动性和高扩展性应用程序的标准方法之一。这种技术为我们提供了一种用于处理数据通信的简单，可伸缩和可复用的机制，这对前端开发人员来说非常有用。在本文中，我们将深入探讨如何使用 Express.js 和 Mongoose 构建 RESTful API，包括代码示例和最佳实践。
什么是 RESTful API？
RESTful API 是一种用于建立 Web 应用程序的架构风格，它使用 HTTP 协议来执行 CRUD（增加、读取、更新、删除）操作，这些操作直接针对 Web 开发所使用的数据源进行。RESTful 规定了如下四个原则：
- 使用统一的资源标识符（URI）来标识互联网资源，例如
https://api.example.com/users/123。 - 通过 HTTP 方法（GET、POST、PUT、DELETE 等）来定义针对资源的操作。
- 返回内容的表述形式和内容的本身是分离的，例如 JSON、XML 或 HTML 等格式。
- 消息应该是无状态的，这意味着，必须包含有关客户端操作的所有信息。
构建 RESTful API 的常用工具
Express.js 是一个广泛使用的 Node.js 框架，提供了可用于构建 Web 应用程序所需的许多实用功能。通过 Express.js，我们可以轻松构建 RESTful API，并轻松管理路由，中间件和异常处理。
Mongoose 是 MongoDB 的一个对象文档模型（ODM），它允许我们以编程方式与 MongoDB 数据库进行交互，而无需使用 SQL。
开始用 Express.js 和 Mongoose 构建 RESTful API
第一步：安装依赖项
在开始构建应用程序之前，我们需要安装一些必要的软件包和库，以便我们能够建立和执行应用程序。以下是我们需要安装的软件包和库：
- Express.js
- Mongoose
- body-parser
- nodemon
使用以下命令在项目中安装它们：
npm i express mongoose body-parser nodemon
第二步：编写基本服务器
在这一步中，我们将编写一个基本的服务器来启用我们的 RESTful API。在与此代码相关的文件中，我们将创建一个名为 server.js 的新文件。以下是我们将要编写的步骤：
- 导入依赖项：我们需要使用
require()来导入我们在第一步中安装的所有软件包和库。
const express = require('express')
const bodyParser = require('body-parser')
const mongoose = require('mongoose')
const app = express()- 配置服务器：我们使用
app.use()和app.set()来配置我们的服务器应在哪个端口上运行，并使我们的服务器使用 body-parser 中间件来解析请求体。
app.use(bodyParser.json())
app.set('port', process.env.PORT || 5000)- 启用服务器：我们使用
app.listen()来启动我们的服务器。下面是完整的server.js代码：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ---------- - ---------------------- ----- -------- - ------------------- ----- --- - --------- -------------------------- --------------- ---------------- -- ----- --------------------------- -- -- - -------------------- ------ -- --------- -- ---- -------------------- --
- 启动服务器：运行以下命令以启动服务器：
node server.js
第三步：连接数据库
在本步骤中，我们将使用 Mongoose 来连接 MongoDB 数据库。我们将在 server.js 文件中重新打开连接。下面是代码：
mongoose.connect('mongodb://localhost/RESTful_API', {
useNewUrlParser: true,
useUnifiedTopology: true,
useCreateIndex: true,
useFindAndModify: false
}, () => {
console.log("Connected to MongoDB!")
})你需要将 mongodb://localhost/RESTful_API 替换为你的 MongoDB 数据库 URL。
第四步：创建数据库模型
在本步骤中，我们将使用 Mongoose 来创建 User 数据库模型。每个 Mongoose 数据库模型对应于我们在 MongoDB 中的集合。我们将使用 Mongoose 的 Schema 和 model() 方法来创建 User 数据库模型。以下是代码：
-- -------------------- ---- -------
----- ---------- - --- -----------------
---------- -
----- -------
--------- ----
--
--------- -
----- -------
--------- ----
--
------ -
----- -------
--------- -----
------- ----
--
--------- -
----- -------
--------- ----
-
--
----- ---- - ---------------------- -----------
-------------- - ----在上述代码中，我们首先创建一个 userSchema，其中包含 firstName、lastName、email 和 password 字段。然后，我们将 userSchema 传递给 mongoose.model() 方法，并将其命名为 User。
第五步：编写控制器和路由
在本步骤中，我们将创建控制器和路由，用于处理我们的 HTTP 请求。在至少一个 API 端点中，将使用控制器和路由。对于这种情况，我们将使用用户端点。创建新文件 userController.js 和 userRoute.js 并添加以下内容：
userController.js：
-- -------------------- ---- -------
----- ---- - ----------------------
------------------ - ----- ----- ---- -- -
--- -
----- ---- - --- --------------
----- -----------
--------------
- ----- ------- -
---------------------------
-
-
---------------- - ----- ----- ---- -- -
--- -
----- ----- - --------- -- --
----- ----- - ----- ----------------
---------------
- ----- ------- -
---------------------------
-
-
------------------ - ----- ----- ---- -- -
--- -
----- ------- - ---------------------
----- -------------- - ------------- ----------- -------- -----------
----- ---------------- - ---------------------- -- --------------------------------
-- ------------------- -
------ ---------------------- ------ -------- --------- --
-
----- ---- - ----- ----------------------- ---- ------------- -- --------- - ---- ---- --
--------------
- ----- ------- -
---------------------------
-
-
------------------ - ----- ----- ---- -- -
--- -
----- ---- - ----- ----------------------- ---- ------------- --
-- ------- -
------ ----------------------
-
--------------
- ----- ------- -
---------------------------
-
-在 userController.js 文件中，我们创建了 createUser()、getUsers()、updateUser() 和 deleteUser() 方法来处理与特定用户相关的所有 HTTP 请求。
userRoute.js：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------ - ---------------- ----- -------------- - --------------------------- --------------------- -------------------------- -------------------- ------------------------ -------------------------- -------------------------- --------------------------- -------------------------- -------------- - ------
在 userRoute.js 文件中，我们创建了四个路由的定义，用于 userController.js 中定义的四个控制器方法。
第六步：将路由添加到服务器
在完成以前几步的步骤之后，我们将 userRoute.js 中的路由添加到我们在 server.js 文件中实例化的 express 实例中。其中一个方法是使用 app.use()，就像我们在配置服务器时所做的那样。在这里，我们将使用 /api 这个URL前缀来添加我们的路由。
const userRoute = require('./userRoute')
app.use('/api', userRoute)第七步：启动应用程序和测试 RESTful API
在完成以上所有步骤后，我们将启动我们的服务器并使用 Postman 软件测试我们刚刚创建的 RESTful API。首先运行 nodemon server.js。连接到服务器后，您可以使用 Postman 应用程序进行测试，例如：
- 创建用户
URL：POST /api/users
请求体：
{
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"password": "secret"
}响应：
{
"_id": "5e9f9a4c4be85707cf39614c",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"password": "secret",
"__v": 0
}- 获取所有用户
URL：GET /api/users
响应：
-- -------------------- ---- -------
-
-
------ ---------------------------
------------ -------
----------- ------
-------- -------------------
----------- ---------
------ -
-
-- 更新用户
URL：PATCH /api/users/5e9f9a4c4be85707cf39614c
请求体：
{
"firstName": "John Jr.",
"lastName": "Doe Jr.",
"password": "12345"
}响应：
{
"_id": "5e9f9a4c4be85707cf39614c",
"firstName": "John Jr.",
"lastName": "Doe Jr.",
"email": "john@example.com",
"password": "12345",
"__v": 0
}- 删除用户
URL：DELETE /api/users/5e9f9a4c4be85707cf39614c
响应：
{
"_id": "5e9f9a4c4be85707cf39614c",
"firstName": "John Jr.",
"lastName": "Doe Jr.",
"email": "john@example.com",
"password": "12345",
"__v": 0
}附加的最佳实践
以下是一些有关构建 RESTful API 的最佳实践：
- 使用 HTTP 动词：使用明确的 HTTP 动词来定义操作，例如
POST、GET、PUT和DELETE。 - 使用正确的状态码：为每个 HTTP 请求使用适当的状态码，例如
200 OK、201 Created、204 No Content、400 Bad Request、401 Unauthorized、403 Forbidden和404 Not Found。 - 签名请求：使用数字签名、Access Key 和 Secret Key 等术语来保护资源的安全性，并防止 CSRF 攻击。
- 发送适当的错误信息：包括清晰、准确和详细的错误信息使错误易于调试，并帮助更快地解决问题。
- 使用版本控制：使用版本控制策略，使您的 API 表示从哪个版本开始，并增加新特性时保持向后兼容性和 API 兼容性。
- 缓存数据：使用适当的缓存策略来减少网络往返并提高响应时间，例如浏览器缓存和服务器端缓存。
- 捕获错误：为了防止发生故障，使用 try / catch 块来捕获和记录任何错误，并正确处理异常。
结论
通过使用 Express.js 和 Mongoose 我们已经建立了一个完全符合 RESTful API 的 Web 应用程序。RESTful API 为开发人员提供了一种易于开发、易于使用和具有强大可扩展性的方法，可在 Web 应用程序中广泛使用。本文提供了一些重要的技巧，并提供了概述，使您可以成功构建 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66f7a4ccc5c563ced5a530f5