使用 Express.js 构建 API 的初学者指南

API（应用程序编程接口）是现代 Web 应用程序的支柱，支持前端和后端之间的通信。 Express.js 是用 JavaScript 构建 API 的最流行的工具之一，它是一个极简且灵活的 Node.js 框架。本指南将引导您了解使用 Express.js 构建 API 的基础知识。

什么是 Express.js？
Express.js 是一个轻量级框架，用于使用 Node.js 构建服务器端应用程序。它简化了处理 HTTP 请求、路由和中间件集成等任务，使其成为创建 API 的绝佳选择。

为什么使用 Express.js？

• 易于使用：语法简单，设置快速。
• 灵活性：可使用中间件进行定制，以添加身份验证、日志记录和错误处理等功能。
• 可扩展性：适用于小型和大型应用程序。

设置 Express.js 环境

第 1 步：安装 Node.js
确保您已安装 Node.js。如有需要，请从nodejs.org下载。

第 2 步：初始化您的项目
创建一个新的项目目录并初始化它：

mkdir express-api  
cd express-api  
npm init -y 

这将创建一个 package.json 文件来管理依赖项。

第 3 步：安装 Express.js
使用 npm 安装 Express.js：

npm install express  

构建您的第一个 API

第 1 步：创建基本服务器
首先创建一个 server.js 文件并添加以下代码：

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

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  

使用以下命令运行服务器：

node server.js 

访问http://localhost:3000，你会看到服务器正在运行（尽管它还不会返回任何内容）。

第 2 步：定义您的第一条路线
路由定义您的 API 如何响应客户端请求。添加一个简单的路由来返回欢迎消息：

app.get('/', (req, res) => {  
  res.send('Welcome to your first Express API!');  
});  

重新启动服务器，访问 http://localhost:3000 现在将显示该消息。

第 3 步：创建 API 端点
让我们添加一个端点来处理数据。例如，返回用户列表的 /users 路由：

const users = [  
  { id: 1, name: 'Alice' },  
  { id: 2, name: 'Bob' },  
  { id: 3, name: 'Charlie' }  
];  

app.get('/users', (req, res) => {  
  res.json(users);  
}); 

访问 http://localhost:3000/users 现在将返回 JSON 格式的用户数据。

添加中间件
Express.js 中的中间件函数处理请求和响应。例如，您可以使用中间件来解析客户端发送的 JSON 数据。

第 1 步：使用内置中间件
要启用 JSON 解析，请添加以下内容：

app.use(express.json());  

第 2 步：处理 POST 请求
添加创建新用户的路线：

mkdir express-api  
cd express-api  
npm init -y 

现在您可以向 http://localhost:3000/users 发送带有 JSON 数据的 POST 请求来添加新用户。

错误处理
要优雅地处理错误，请使用中间件。例如：

npm install express  

这可确保任何未处理的错误返回有意义的响应。

最终代码
这是完整的示例：

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

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  

结论
Express.js 使构建 API 变得简单而高效，提供了快速入门所需的工具和灵活性。通过了解设置路由、处理数据和使用中间件的基础知识，您可以为您的 Web 应用程序创建强大的 API。

继续探索身份验证、数据库集成和高级错误处理等功能，将您的 API 提升到新的水平！

以上是使用 Express.js 构建 API 的初学者指南的详细内容。更多信息请关注PHP中文网其他相关文章！