在现代 Web 应用开发中，RESTful API 成为了一种非常流行的接口设计方式。它的优点是简单易懂、易于扩展和重用，同时也符合 Web 标准。本文将介绍如何使用 Node.js + Express + Mongoose 构建 RESTful API，让前端开发者能够更好地利用其功能和优势。
技术概述
- Node.js: 一种基于 JavaScript 运行的后端开发平台，可以用于构建 Web 应用、命令行工具和其他服务器端应用程序。它使用事件驱动、非阻塞 I/O 模型，可以处理大量并发连接，非常适合构建高性能的实时 Web 应用。
- Express: 是一个基于 Node.js 平台的 Web 应用框架，提供了一组简单、灵活的 API，帮助开发者构建 Web 应用程序。它具有路由、中间件、模板引擎等常用功能，可以轻松实现多种 Web 应用。
- Mongoose: 是一个优秀的 MongoDB Node.js 驱动程序，可以提供更高层次的 API 和更好的抽象。它支持模式定义、类型转换、验证、查询构建等功能，可以更好地利用 MongoDB 的功能和优势。
API 设计
在构建 RESTful API 时，需要遵循一定的规范和约定。主要包括以下几点：
- 使用 HTTP 方法表示资源操作。例如，使用 GET 方法获取资源，使用 POST 方法创建资源，使用 PUT 方法更新资源，使用 DELETE 方法删除资源。
- 使用 URL 表示资源位置。例如，/users 表示所有用户，/users/1 表示编号为 1 的用户。
- 使用 HTTP 状态码表示操作结果。例如，200 表示成功，201 表示已创建，400 表示请求不合法，404 表示未找到资源，500 表示服务器错误。
- 使用 JSON 格式传输数据。JSON 是一种轻量级、简单的数据格式，易于处理和解析，可以广泛用于数据传输和存储。
基于上述规范和约定，我们可以设计一个简单的用户管理 RESTful API，包括以下几个功能：
- GET /users 获取所有用户
- POST /users 创建一个新用户
- GET /users/:id 获取指定编号的用户
- PUT /users/:id 更新指定编号的用户
- DELETE /users/:id 删除指定编号的用户
项目搭建
首先，我们需要初始化一个空的 Node.js 项目：
mkdir node-express-mongoose && cd node-express-mongoose npm init -y
然后，安装 Express 和 Mongoose：
npm install express mongoose
创建一个 index.js 文件，并写入以下代码：
// javascriptcn.com 代码示例
const express = require("express");
const mongoose = require("mongoose");
const app = express();
const port = 3000;
mongoose.connect("mongodb://localhost:27017/node-express-mongoose", {
useNewUrlParser: true,
useUnifiedTopology: true,
});
const db = mongoose.connection;
db.on("error", console.error.bind(console, "MongoDB connection error:"));
app.listen(port, () => {
console.log(`Server is running on port ${port}.`);
});这段代码做了以下几件事情：
- 导入 Express 和 Mongoose。
- 创建一个 Express 应用实例，并指定监听的端口号为 3000。
- 使用 Mongoose 连接 MongoDB 数据库，数据库名称为 node-express-mongoose。
- 如果连接错误，则输出错误信息。
- 在控制台输出服务器已经启动的信息。
可以通过运行以下命令来启动服务器：
node index.js
如果一切正常，控制台应该会输出 "Server is running on port 3000."。
API 实现
接下来，我们需要实现上述 API 的所有功能。这里使用 Mongoose 对 MongoDB 进行操作。
首先，我们需要定义一个 User 模式，并注册到 Mongoose 中。在 index.js 文件中添加以下代码：
const userSchema = new mongoose.Schema({
name: String,
age: Number,
});
const User = mongoose.model("User", userSchema);这段代码定义了一个 User 模式，包含了名字和年龄两个字段。使用 mongoose.model 方法将其注册到 Mongoose 中，并指定模式名称为 "User"。
现在，我们可以实现上述所有功能。在 index.js 文件中添加以下代码：
// javascriptcn.com 代码示例
app.use(express.json());
app.get("/users", async (req, res) => {
const users = await User.find();
res.send(users);
});
app.post("/users", async (req, res) => {
const { name, age } = req.body;
const user = new User({ name, age });
await user.save();
res.status(201).send(user);
});
app.get("/users/:id", async (req, res) => {
const { id } = req.params;
const user = await User.findById(id);
if (!user) {
return res.status(404).send({ message: "User not found" });
}
res.send(user);
});
app.put("/users/:id", async (req, res) => {
const { id } = req.params;
const { name, age } = req.body;
const user = await User.findByIdAndUpdate(id, { name, age }, { new: true });
if (!user) {
return res.status(404).send({ message: "User not found" });
}
res.send(user);
});
app.delete("/users/:id", async (req, res) => {
const { id } = req.params;
const user = await User.findByIdAndDelete(id);
if (!user) {
return res.status(404).send({ message: "User not found" });
}
res.send(user);
});
app.use((req, res, next) => {
res.status(404).send({ message: "Resource not found" });
});
app.use((err, req, res, next) => {
console.error(err.stack);
res.status(500).send({ message: "Internal server error" });
});这段代码做了以下几件事情：
- 使用 app.use(express.json()) 中间件，解析请求体为 JSON 格式。
- 实现 GET /users，从数据库中查找所有用户，并返回 JSON 格式的用户列表。
- 实现 POST /users，从请求体中获取用户的 name 和 age 字段，并将其保存到数据库中。操作成功后，返回 JSON 格式的创建的用户信息，并设置状态码 201。
- 实现 GET /users/:id，获取指定编号的用户。如果查询不到用户，则返回状态码 404 和错误信息。
- 实现 PUT /users/:id，更新指定编号的用户。如果查询不到用户，则返回状态码 404 和错误信息。
- 实现 DELETE /users/:id，删除指定编号的用户。如果查询不到用户，则返回状态码 404 和错误信息。
- 使用 app.use((req, res, next)) 中间件，捕获所有的 404 错误，并返回错误信息。
- 使用 app.use((err, req, res, next)) 中间件，捕获所有的 500 错误，并返回错误信息。
示例代码
完整的示例代码可以参考以下 Github 仓库：node-express-mongoose
总结
本文介绍了如何使用 Node.js + Express + Mongoose 构建 RESTful API，实现了基本的用户管理功能。在开发过程中，需要遵循 RESTful API 设计规范和约定，并使用优秀的 Node.js 模块进行开发。Mongoose 可以帮助我们更好地利用 MongoDB 的功能和优势，提高开发效率和代码质量。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/652eb6c67d4982a6ebfc9421