使用Express.js构建RESTful API:初学者指南 - Medium

作者:API传播员 · 2025-12-16 · 阅读时间:5分钟
本文介绍了使用Express.js构建RESTful API的完整步骤,包括安装设置、定义路由、实现CRUD操作和测试API。作为初学者指南,它详细解释了RESTful API的基本概念和Express.js的易用性,帮助开发者快速上手Web开发。

什么是RESTful API?

CRUD 操作:

  • 创建(POST):创建新资源。
  • 读取(GET):检索现有资源。
  • 更新(PUT/PATCH):更新现有资源。
  • 删除(DELETE):删除现有资源。

接下来,我们将通过 Express.js 构建一个简单的 RESTful API。


为什么选择 Express.js?

Express.js 是一个流行的 Node.js Web 框架,提供了简单且强大的工具来构建 RESTful API。它的灵活性和易用性使其成为开发者的首选。


使用 Express.js 构建 RESTful API 的步骤

要使用 Express.js 构建 RESTful API,可以按照以下步骤操作:

  1. 安装并设置 Express.js:安装 Express.js 并配置基本的服务器。
  2. 定义路由:为 API 定义路由,指定 HTTP 方法(如 GET、POST、PUT、DELETE)、路由 URL 和处理请求的回调函数。
  3. 实现 CRUD 操作:结合数据库或数据存储机制,为每个路由实现 CRUD 操作。
  4. 测试 API:使用 Postman 等工具测试 API,验证其功能。

安装并设置 Express.js

首先,通过 npm 安装 Express.js:

npm install express --save

然后,在项目根目录创建一个名为 app.js 的文件,并添加以下代码:

const express = require('express');
const app = express();

const port = 3000;app.get('/', (req, res) => {
  res.send('Hello, World!');
});app.listen(port, () => {
  console.log(Server running at http://localhost:${port});
});

运行此文件后,您将能够通过浏览器访问 http://localhost:3000,并看到“Hello, World!”的响应。


定义路由和实现 CRUD 操作

接下来,我们将使用 Express.js 的路由功能为 API 定义路由。创建一个名为 routes.js 的文件,并添加以下代码:

const express = require('express');
const router = express.Router();

// 定义路由
router.get('/users', (req, res) => {
  res.send('List of users');
});router.get('/users/:id', (req, res) => {
  const userId = req.params.id;
  res.send(Details of user ${userId});
});router.post('/users', (req, res) => {
  res.send('Create a new user');
});router.put('/users/:id', (req, res) => {
  const userId = req.params.id;
  res.send(Update user ${userId});
});router.delete('/users/:id', (req, res) => {
  const userId = req.params.id;
  res.send(Delete user ${userId});
});module.exports = router;

挂载路由

app.js 中,通过引入 routes.js 文件并使用 app.use() 方法将路由挂载到特定路径。更新后的 app.js 文件如下:

const express = require('express');
const app = express();
const port = 3000;

const routes = require('./routes');app.use('/api', routes);app.listen(port, () => {
  console.log(Server running at http://localhost:${port});
});

现在,您的 API 路由已成功配置。例如,访问 http://localhost:3000/api/users 将返回“List of users”。


测试 API

使用 Postman 或类似工具测试 API 的功能。以下是一些示例请求:

  • GET 请求:访问 http://localhost:3000/api/users,期望返回“List of users”。
  • POST 请求:向 http://localhost:3000/api/users 发送请求,期望返回“Create a new user”。
  • PUT 请求:向 http://localhost:3000/api/users/:id 发送请求,更新指定用户。
  • DELETE 请求:向 http://localhost:3000/api/users/:id 发送请求,删除指定用户。

总结

通过本文,您学习了如何使用 Express.js 构建一个简单的 RESTful API。我们从安装和设置 Express.js 开始,定义了路由,并实现了基本的 CRUD 操作。接下来,您可以进一步扩展 API,例如集成数据库(如 MongoDB)以存储和管理数据。

构建 RESTful API 是现代 Web 开发中的一项重要技能。通过不断实践,您将能够创建更复杂和功能更强大的 API。

原文链接: https://medium.com/@skhans/building-a-restful-api-with-express-js-a-beginners-guide-dcb1a1e3520d