介绍
RESTful API 是一种非常流行的 Web 应用程序开发方式，其注重资源的标识和状态的变化，并使用 HTTP 方法来操作这些资源。Node.js、Express.js 和 MongoDB 组合可以帮助我们很方便地创建 RESTful API。
在这篇文章中，我们将提供有关如何使用 Node.js、Express.js 和 MongoDB 创建 RESTful API 的详细指导。我们还将讨论 RESTful API 的设计和处理数据的最佳实践，并提供示例代码来帮助您更好地理解这些概念。
环境设置
在开始使用 Node.js、Express.js 和 MongoDB 创建 RESTful API 之前，您需要安装以下软件：
- Node.js (>= v8.x.x)
- MongoDB Community Server (>=v3.x.x)
安装完成后，我们需要使用 npm 或 yarn 来安装 Express.js 框架和 MongoDB 驱动程序，如下所示：
$ npm install --save express mongoose
设计 RESTful API
在我们开始写代码前，我们需要确定我们希望实现的 RESTful API 的设计。我们需要考虑以下因素：
- 资源的标识，如何访问它
- 资源的增加、删除、更新和查询操作
- 如何处理资源的关系
在我们设计 RESTful API 时，我们应该遵循以下最佳实践：
- 使用语义明确且易于理解的 URI
- 使用 HTTP 方法来执行操作
- 响应 HTTP 状态码，以表明成功或失败的操作
- 提供清晰的错误消息
实现 RESTful API
我们将通过构建一个简单的 To-Do list RESTful API，并使用以下路由和操作来实现：
- GET /api/todos：获取所有的 todo
- POST /api/todos：创建一个新的 todo
- GET /api/todos/:id：获取一个特定的 todo
- PUT /api/todos/:id：更新一个特定的 todo
- DELETE /api/todos/:id：删除一个特定的 todo
让我们逐步实现每个操作：
连接数据库
我们需要首先连接到 MongoDB 数据库来保存我们的 todo 数据。在我们开始构建 RESTful API 之前，我们需要使用以下代码连接我们的数据库：
-- -------------------- ---- ------- ----- -------- - -------------------- ----------------------------------------------- - --------------- ----- ---------------- ----- ------------------- ---- -- -------- -- ---------------------- -- ---------- ------------ -- -------------------- --- ------- -- --------- ------
创建模型
然后，我们需要定义我们的 todo 模型。在我们的应用程序中有一个 todo，应该具有以下属性：
- 字符串类型的
title - 字符串类型的
description - 布尔类型的
completed - 日期类型的
createdAt和updatedAt
我们可以使用以下代码定义我们的模型：
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ---------- - --- ----------------- ------ - ----- ------- --------- ---- -- ------------ - ----- ------- --------- ---- -- ---------- - ----- -------- -------- ----- -- ---------- - ----- ----- -------- -------- -- ---------- - ----- ----- -------- -------- - --- -------------- - ---------------------- ------------
创建路由
我们将创建一个路由来处理我们 To-Do list 中的操作。我们首先需要使用以下代码导入 express：
const express = require('express');
const router = express.Router();然后，我们可以开始使用路由，如下所示：
获取所有的 todo
const Todo = require('../models/todo');
router.get('/api/todos', async (req, res) => {
const todos = await Todo.find().sort('-createdAt');
res.send(todos);
});我们使用 Todo.find() 查询数据库中的所有 todo，并在调用 sort() 方法时按 createdAt 字段进行排序。最后我们使用 res.send() 方法将查询结果返回到客户端。
创建一个新的 todo
-- -------------------- ---- -------
------------------------- ----- ----- ---- -- -
----- ---- - --- ------
------ ---------------
------------ --------------------
---
----- ------------
---------------
---我们创建一个新的 todo 对象，并将客户端 POST 请求中的 title 和 description 对象作为参数。我们然后调用 save() 方法将这个对象保存到数据库中，并最后使用 res.send() 方法返回该对象。
获取一个特定的 todo
router.get('/api/todos/:id', async (req, res) => {
const todo = await Todo.findById(req.params.id);
if (!todo) {
return res.status(404).send('The todo with the given ID was not found.');
}
res.send(todo);
});我们使用 req.params.id 获取客户端 GET 请求中的 id 参数，并使用 Todo.findById() 查询数据库中的特定 todo。如果查询结果为空，则我们将使用 res.status() 方法返回 404 状态码和错误信息；否则，我们将使用 res.send() 方法返回查询结果。
更新一个特定的 todo
-- -------------------- ---- -------
---------------------------- ----- ----- ---- -- -
----- ---- - ----- ------------------------------------- -
------ ---------------
------------ ---------------------
---------- -------------------
---------- ----------
-- - ---- ---- ---
-- ------- -
------ ------------------------- ---- ---- --- ----- -- --- --- ---------
-
---------------
---我们使用 Todo.findByIdAndUpdate() 操作来更新数据库中的特定 todo。我们首先获取客户端 PUT 请求中的 id 参数，并将修改后的属性保存到对象中。我们指定 new: true 选项，以确保返回更新后的对象，而不是更新前的对象。
删除一个特定的 todo
-- -------------------- ---- -------
------------------------------- ----- ----- ---- -- -
----- ---- - ----- --------------------------------------
-- ------- -
------ ------------------------- ---- ---- --- ----- -- --- --- ---------
-
---------------
---我们使用 Todo.findByIdAndRemove() 操作来删除数据库中的特定 todo。我们首先获取客户端 DELETE 请求中的 id 参数。如果查询结果为空，我们将使用 res.status() 方法返回 404 状态码和错误消息；否则，我们将使用 res.send() 方法返回查询结果。
允许跨域
在我们启动我们的应用程序之前，我们需要为我们的 RESTful API 启用 CORS（Cross-Origin Resource Sharing）。使用以下代码可以启用 CORS：
const cors = require('cors');
app.use(cors());示例代码
最后，这里是所有示例代码的完整版本：
-- -------------------- ---- -------
----- ------- - -------------------
----- -------- - --------------------
----- ---- - ----------------
----- --- - ----------
------------------------
----------------
----------------------------------------------- -
--------------- -----
---------------- -----
------------------- ----
--
-------- -- ---------------------- -- ----------
------------ -- -------------------- --- ------- -- --------- ------
----- ---------- - --- -----------------
------ - ----- ------- --------- ---- --
------------ - ----- ------- --------- ---- --
---------- - ----- -------- -------- ----- --
---------- - ----- ----- -------- -------- --
---------- - ----- ----- -------- -------- -
---
----- ---- - ---------------------- ------------
----- ---- - ---------------- -- -----
---------------- -- -- ---------------------- -- ---- --------------
--------------------- ----- ----- ---- -- -
----- ----- - ----- -------------------------------
----------------
---
---------------------- ----- ----- ---- -- -
----- ---- - --- ------
------ ---------------
------------ --------------------
---
----- ------------
---------------
---
------------------------- ----- ----- ---- -- -
----- ---- - ----- -----------------------------
-- ------- -
------ ------------------------- ---- ---- --- ----- -- --- --- ---------
-
---------------
---
------------------------- ----- ----- ---- -- -
----- ---- - ----- ------------------------------------- -
------ ---------------
------------ ---------------------
---------- -------------------
---------- ----------
-- - ---- ---- ---
-- ------- -
------ ------------------------- ---- ---- --- ----- -- --- --- ---------
-
---------------
---
---------------------------- ----- ----- ---- -- -
----- ---- - ----- --------------------------------------
-- ------- -
------ ------------------------- ---- ---- --- ----- -- --- --- ---------
-
---------------
---结论
使用 Node.js、Express.js 和 MongoDB 创建 RESTful API 可以让我们轻松快捷地构建 Web 应用程序，同时还可以遵循最佳实践和清晰的设计方案。本文提供了有关如何开始使用和实现 RESTful API 的详细指南和示例代码，希望您能从中学到方法和技巧，快速地构建您的 Web 应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6715e177ad1e889fe21949fa