介绍
在本篇文章中,我们将介绍如何使用 Express.js 和 MongoDB 创造 RESTful API。Express.js 是一个广泛使用的 Node.js 应用程序框架,而 MongoDB 则是一个非关系数据库管理系统,我们将使用它来存储我们的数据。
RESTful API 是一种 Web API 设计模式,可以轻松地集成和扩展服务,并根据需要添加新功能。基本上,RESTful API 将使用 HTTP 请求创建,读取,更新和删除记录,并将响应发送回客户端。
在本文中,我们将演示如何使用 Express 和 MongoDB 创建一个完全可扩展的 RESTful API。我们将包括:
- 安装和配置 Express.js 和 MongoDB。
- 创建数据模型和路由来处理 API 请求。
- 编写示例代码以演示如何使用 API。
现在让我们开始吧!
第 1 步:安装和配置 Express.js 和 MongoDB
在我们开始编写代码之前,我们需要安装 Node.js、Express.js 和 MongoDB。
Node.js 安装
在 Node.js 的官方网站上下载和安装最新版本的 Node.js。
Express.js 安装和配置
安装 Express.js 的步骤如下:
- 安装 Node.js 后打开终端或命令提示符。
- 输入以下命令以创建一个示例项目:
----- ------------ -- ------------ --- ----
该命令将创建一个新的 Node.js 项目并提示您填写一些基本信息,如项目名称,作者,版本号等。
- 接下来,输入以下命令以安装 Express.js:
--- ------- ------- ------
此命令会将 Express.js 添加到您的项目中,并将其保存到 package.json 文件中。
- 创建一个名为
app.js
的文件,将以下示例代码添加到文件中:
----- ------- - ------------------- ----- --- - ---------- ------------ ----- ---- -- - ---------------- --------- --- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
该代码创建一个新的 Express.js 应用程序,并使用 app.get()
方法来处理 HTTP GET 请求。当访问网站的根目录时,该回调函数将返回“Hello, World!”。
- 运行以下命令以启动应用程序:
---- ------
现在,您可以在浏览器中打开 http://localhost:8000并查看应用程序。
MongoDB 安装和配置
在 MongoDB 的官方网站上下载和安装最新版本的 MongoDB。
启动 MongoDB 后,开打终端或命令提示符,并输入以下命令以连接到 MongoDB:
-----
现在,我们已经安装和配置了 Express.js 和 MongoDB,让我们开始创建 RESTful API!
第 2 步:创建数据模型和路由
RESTful API 的核心是处理 HTTP 请求并响应所需的数据。在我们的示例应用程序中,我们将创建一个用户模型和路由来处理 CRUD 操作。
用户模型
用户模型文件 user.js
如下:
----- -------- - -------------------- ----- ---------- - --- ----------------- ----- - ----- ------- --------- ---- -- ------ - ----- ------- --------- ----- ------- ---- -- --------- - ----- ------- --------- ---- -- ---------- - ----- ----- -------- -------- - --- ----- ---- - ---------------------- ------------ -------------- - -----
上面的代码定义了用户模型,它有四个属性:名称,电子邮件地址,密码和使用默认值创建的创建时间。我们使用 Mongoose 来管理 MongoDB 中的数据模型。
用户路由
路由文件 users.js
如下:
----- ------- - ------------------- ----- ------ - ----------------- ----- ---- - -------------------------- -- --- --- ----- --------------- ----- ----- ---- ----- -- - --- - ----- ----- - ----- -------------- ---------------- - ----- ------- - ------------ - --- -- --- - ---- -- -- ------------------ ----- ----- ---- ----- -- - --- - ----- ---- - ----- ----------------------------- --------------- - ----- ------- - ------------ - --- -- ------ - --- ---- ---------------- ----- ----- ---- ----- -- - --- - ----- ---- - ----- ---------------------- --------------- - ----- ------- - ------------ - --- -- ------ - ---- ------------------- ----- ----- ---- ----- -- - --- - ----- ---- - ----- ------------------------------------- --------- - ---- ---- --- --------------- - ----- ------- - ------------ - --- -- ------ - ---- --------------------- ----- ----- ---- ----- -- - --- - ----- ---- - ----- -------------------------------------- --------------- - ----- ------- - ------------ - --- -------------- - -------
上述代码将 GET,POST,PUT 和 DELETE 请求映射到不同的路由处理程序中。使用 async
/ await
来处理路由控制器中的异步操作。
现在我们已经创建了用户模型和路由,接下来让我们展示如何使用 RESTful API。
第 3 步:使用 RESTful API
现在我们已经有了用户模型和路由,让我们使用该 API 创建、读取、更新和删除用户。
创建用户
要创建用户,请使用 HTTP POST 请求并提供以下信息:
- ------- ----- ----- -------- ----------------------- ----------- ---------- -
---- ---------- --------- ---- ----------------------------- - -------- -------------- ----------------- - ---------- -- ------- ----- ----- -------- ----------------------- ----------- ---------- --
这将在 MongoDB 数据库中创建一个名为“John Doe”的新用户。
读取用户
要获取特定用户,请使用 HTTP GET 请求和该用户的 ID:
---- ---------- --------- --- ------------------------------------------------------
这将返回 ID 为“603e9498d1c78403f499495b”的用户的详细信息。
更新用户
要更新用户,请使用 HTTP PUT 请求和该用户的 ID,并提供要更新的新值:
- ------- ----- ----- -------- ----------------------- ----------- ------------- -
---- ---------- --------- --- ------------------------------------------------------ - -------- -------------- ----------------- - ---------- -- ------- ----- ----- -------- ----------------------- ----------- ------------- --
这将更新 ID 为“603e9498d1c78403f499495b”的用户的名称和电子邮件地址。
删除用户
要删除用户,请使用 HTTP DELETE 请求和该用户的 ID:
---- ---------- --------- ------ ------------------------------------------------------
这将从 MongoDB 数据库中删除名为“John Doe”的用户。
结论
在本文中,我们已经演示了如何使用 Express.js 和 MongoDB 创建 RESTful API。我们看到如何安装和配置 Express.js 和 MongoDB,创建数据模型和路由,以及如何使用 API 创建、读取、更新和删除用户。
通过学习 RESTful API,我们可以学习如何创建高度可组合,可扩展且易于理解的 API。对于初学者来说,这是一个非常有用的练习,可以帮助他们加深对网络请求以及编写 Node.js 应用程序的理解。
最后,我们希望这篇文章能够为您提供足够的指导,并鼓励您继续探索 Node.js 和 Express.js 生态系统中的其他工具和库。
来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/67289a0f2e7021665e20d8fd