从零开始搭建一个RESTful API（Node.js + Express）

随着Web开发的普及，RESTful API已经成为开发者在后端开发中的常见方式。RESTful API通过标准的HTTP方法（GET、POST、PUT、DELETE）实现客户端和服务器之间的通信，使得前后端开发能够解耦，前端可以通过API获取数据并进行展示。本篇博客将带你从零开始使用Node.js和Express搭建一个简单的RESTful API。

1. 环境准备

在开始编写代码之前，我们需要准备开发环境：

Node.js：Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，主要用于开发服务器端应用。
Express：Express 是一个简洁且灵活的 Node.js Web 应用框架，提供了一系列强大的功能用于开发 Web 和移动应用。

安装步骤：

安装Node.js（如果还没有安装）。
创建一个项目文件夹并初始化Node.js项目：
```
mkdir my-rest-api
cd my-rest-api
npm init -y
```
安装Express：
```
npm install express --save
```

现在我们已经安装好了Express，可以开始搭建API了。

2. 基础RESTful API实现

2.1 创建`server.js`

在项目根目录中创建一个文件 server.js，并初始化我们的Express服务器：

const express = require('express');
const app = express();
const PORT = 3000;app.use(express.json());// 基础的GET请求
app.get('/', (req, res) => {res.send('欢迎来到我的RESTful API!');
});// 启动服务器
app.listen(PORT, () => {console.log(`服务器正在运行，地址：http://localhost:${PORT}`);
});

运行该文件：

node server.js

现在，你可以打开浏览器访问 http://localhost:3000，看到“欢迎来到我的RESTful API!”的提示，说明服务器已经成功运行。

2.2 定义路由和基本操作

接下来，我们将定义基本的CRUD（Create、Read、Update、Delete）操作。为了模拟数据，我们使用内存中的数据存储，而不需要数据库。

let items = [{ id: 1, name: 'item1' },{ id: 2, name: 'item2' },{ id: 3, name: 'item3' },
];// 获取所有物品
app.get('/api/items', (req, res) => {res.json(items);
});// 获取单个物品
app.get('/api/items/:id', (req, res) => {const item = items.find(i => i.id === parseInt(req.params.id));if (!item) return res.status(404).send('物品未找到');res.json(item);
});// 创建新物品
app.post('/api/items', (req, res) => {const newItem = {id: items.length + 1,name: req.body.name,};items.push(newItem);res.status(201).json(newItem);
});// 更新物品
app.put('/api/items/:id', (req, res) => {const item = items.find(i => i.id === parseInt(req.params.id));if (!item) return res.status(404).send('物品未找到');item.name = req.body.name;res.json(item);
});// 删除物品
app.delete('/api/items/:id', (req, res) => {const item = items.find(i => i.id === parseInt(req.params.id));if (!item) return res.status(404).send('物品未找到');const index = items.indexOf(item);items.splice(index, 1);res.json(item);
});

在这个代码块中，我们实现了以下RESTful API的基础操作：

GET /api/items：获取所有物品。
GET /api/items/:id：根据物品的ID获取单个物品。
POST /api/items：添加一个新的物品。
PUT /api/items/:id：更新已有物品。
DELETE /api/items/:id：删除物品。

你可以使用工具如Postman或curl来测试这些API接口。

3. 处理错误和数据验证

API设计的一个重要部分是处理错误。我们应该确保每个API请求都能返回清晰明确的错误信息。例如，当用户请求一个不存在的物品时，我们已经返回了404错误。

此外，在创建或更新物品时，我们应该确保数据有效。我们可以在POST和PUT请求中进行简单的验证：

app.post('/api/items', (req, res) => {if (!req.body.name || req.body.name.length < 3) {return res.status(400).send('名称不能为空且长度必须大于3');}const newItem = {id: items.length + 1,name: req.body.name,};items.push(newItem);res.status(201).json(newItem);
});app.put('/api/items/:id', (req, res) => {const item = items.find(i => i.id === parseInt(req.params.id));if (!item) return res.status(404).send('物品未找到');if (!req.body.name || req.body.name.length < 3) {return res.status(400).send('名称不能为空且长度必须大于3');}item.name = req.body.name;res.json(item);
});

这里我们添加了对物品名称的验证，确保名称不为空且长度大于3个字符。如果数据无效，API将返回400状态码和相应的错误信息。