Node.js 创建基本服务器与 API 路由模块详解(含完整代码)

目录

Node.js 创建基本服务器与 API 路由模块详解(含完整代码)

一、准备工作

二、项目结构

三、编写代码

1. 创建主服务器文件

2. 创建 API 路由模块

四、运行方式

五、总结


以下是适合发布博客的详细文章内容,介绍如何用 Node.js 创建一个基本的服务器,并实现 API 路由模块化开发,含完整代码、运行结果及文件说明,适合初学者学习使用。

在 Node.js 中,我们可以通过 Express 框架快速搭建一个 Web 服务,同时通过路由模块化的方式,让项目结构更加清晰易维护。本文将详细介绍如何从零开始创建一个基本的服务器,并将 API 路由进行模块化拆分,适合初学者入门。


一、准备工作

  1. 安装 Node.js(推荐使用 LTS 版本)

  2. 新建项目文件夹:mkdir my-server && cd my-server

  3. 初始化项目:npm init -y

  4. 安装 Express 框架:npm install express


二、项目结构

my-server/
│
├── server.js         // 启动主文件
├── routes/
│   └── api.js        // API 路由模块
└── package.json

三、编写代码

1. 创建主服务器文件

文件名:server.js
文件类型:JavaScript

// server.js
const express = require('express');
const app = express();
const apiRouter = require('./routes/api');

// 中间件:用于解析 JSON 数据
app.use(express.json());

// 使用路由模块
app.use('/api', apiRouter);

// 启动服务器
const PORT = 3000;
app.listen(PORT, () => {
  console.log(`Server is running on http://localhost:${PORT}`);
});

2. 创建 API 路由模块

文件名:routes/api.js
文件类型:JavaScript

// routes/api.js
const express = require('express');
const router = express.Router();

// GET 请求:返回欢迎信息
router.get('/hello', (req, res) => {
  res.json({ message: 'Hello, API!' });
});

// POST 请求:接收用户信息
router.post('/user', (req, res) => {
  const { name, age } = req.body;
  res.json({ message: `Received user: ${name}, age: ${age}` });
});

module.exports = router;

四、运行方式

  1. 在终端中运行:

node server.js
  1. 打开浏览器或使用 Postman 测试接口:


五、总结

本文通过简单的例子,展示了如何使用 Node.js 和 Express:

  • 创建一个基本的 Web 服务器

  • 使用中间件解析请求体

  • 将 API 路由进行模块化管理

这种结构不仅方便维护,也便于扩展更多功能。希望本文能帮助你快速入门 Node.js API 开发。


如果你还想了解更多 Express 实战项目、路由、中间件使用等内容,欢迎继续关注后续文章更新。

如需复制代码,请注意区分文件名与类型,直接粘贴到你自己的项目中即可使用。