本教程将指导您使用 Node.js、Express.js 和 MongoDB 构建 RESTful API。我们将涵盖环境设置、定义 API 端点和处理数据持久性。最终，您将拥有一个可扩展的功能性 API。
目录
REST API 和 MongoDB 简介
REST (Representational State Transfer) 是一种用于构建可扩展和可维护 Web 服务的架构风格。REST API 使用标准 HTTP 方法 (GET、POST、PUT、DELETE) 与由 URL 标识的资源进行交互。MongoDB 是一个 NoSQL 文档型数据库，它为存储和检索数据提供了灵活性。这种组合为许多应用程序创建了强大的基础。
设置您的开发环境
在开始之前，请确保您已安装 Node.js 和 npm (Node 包管理器)。您可以从 nodejs.org 下载它们。另外，请确保已安装并运行 MongoDB。您可以从 mongodb.com 下载它。
项目设置和依赖项
创建一个新的项目目录，并在您的终端中导航到它。初始化一个新的 Node.js 项目：
npm init -y
安装必要的依赖项：
npm install express mongoose body-parser
express：一个最小且灵活的 Node.js Web 应用程序框架。mongoose：一个用于 MongoDB 和 Node.js 的对象数据建模 (ODM) 库。body-parser：用于解析 JSON 请求体的中间件。
连接到 MongoDB
创建一个名为 server.js 的文件并添加以下代码：
const express = require('express');
const mongoose = require('mongoose');
const bodyParser = require('body-parser');
const app = express();
const port = 3000;
// MongoDB 连接字符串 - 请替换为您的连接详细信息
const mongoURI = 'mongodb://localhost:27017/mydatabase';
mongoose.connect(mongoURI, { useNewUrlParser: true, useUnifiedTopology: true })
.then(() => console.log('Connected to MongoDB'))
.catch(err => console.error('Error connecting to MongoDB:', err));
app.use(bodyParser.json());
app.listen(port, () => console.log(`Server listening on port ${port}`));
定义 API 端点 (CRUD 操作)
让我们创建一个简单的模型和端点来管理项目。将此添加到您的 server.js 文件中：
const ItemSchema = new mongoose.Schema({
name: String,
description: String
});
const Item = mongoose.model('Item', ItemSchema);
// POST /items - 创建一个新项目
app.post('/items', async (req, res) => {
try {
const newItem = new Item(req.body);
const savedItem = await newItem.save();
res.status(201).json(savedItem);
} catch (error) {
res.status(500).json({ error: error.message });
}
});
// GET /items - 获取所有项目
app.get('/items', async (req, res) => {
try {
const items = await Item.find({});
res.json(items);
} catch (error) {
res.status(500).json({ error: error.message });
}
});
// GET /items/:id - 通过 ID 获取单个项目
app.get('/items/:id', async (req, res) => {
try {
const item = await Item.findById(req.params.id);
if (!item) return res.status(404).json({ message: 'Item not found' });
res.json(item);
} catch (error) {
res.status(500).json({ error: error.message });
}
});
// PUT /items/:id - 更新项目
app.put('/items/:id', async (req, res) => {
try {
const updatedItem = await Item.findByIdAndUpdate(req.params.id, req.body, { new: true });
if (!updatedItem) return res.status(404).json({ message: 'Item not found' });
res.json(updatedItem);
} catch (error) {
res.status(500).json({ error: error.message });
}
});
// DELETE /items/:id - 删除项目
app.delete('/items/:id', async (req, res) => {
try {
const deletedItem = await Item.findByIdAndDelete(req.params.id);
if (!deletedItem) return res.status(404).json({ message: 'Item not found' });
res.json({ message: 'Item deleted' });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
测试您的 API
使用 Postman 或 curl 等工具来测试您的 API 端点。发送 POST 请求到 /items 以创建新项目，发送 GET 请求到 /items 以检索所有项目，并使用 GET、PUT 和 DELETE 请求来处理使用其 ID 的单个项目。
实现强大的错误处理
示例代码包含基本的错误处理。对于生产环境，请实现更全面的错误处理、日志记录和输入验证。
结论和后续步骤
您已成功构建了一个带有 MongoDB 的基本 REST API！通过添加身份验证、授权、数据验证和更复杂的错误处理来扩展它。考虑使用生产就绪的数据库连接，并探索 Express.js 和 Mongoose 的更多高级功能。