现在,是时候将你学到的 Node.js 和 Express 知识付诸实践,构建一个简单的 RESTful API 服务器了。选择以下一个项目:
项目选择 1:博客文章 API
构建一个 API,用于管理博客文章。需要实现以下接口:
GET /api/posts
: 获取所有文章列表。GET /api/posts/:id
: 获取单篇文章详情(根据 ID)。POST /api/posts
: 创建新文章。请求体包含文章标题和内容。PUT /api/posts/:id
: 更新单篇文章的全部信息(根据 ID)。请求体包含更新后的标题和内容。DELETE /api/posts/:id
: 删除单篇文章(根据 ID)。
你可以将文章数据暂时存储在内存中的一个数组里(服务器重启后数据会丢失,但在学习阶段没问题)。
项目选择 2:任务管理 API
构建一个 API,用于管理待办任务。需要实现以下接口:
GET /api/tasks
: 获取所有任务列表。GET /api/tasks/:id
: 获取单个任务详情(根据 ID)。POST /api/tasks
: 创建新任务。请求体包含任务描述和是否完成状态。PUT /api/tasks/:id
: 更新单个任务的全部信息(根据 ID)。请求体包含更新后的描述和是否完成状态。DELETE /api/tasks/:id
: 删除单个任务(根据 ID)。
同样可以将任务数据存储在内存中的一个数组里。
项目要求:
- 使用 Node.js 和 Express 构建应用。
- 按照 RESTful 风格设计 API 端点和使用 HTTP 方法。
- 使用
express.json()
中间件解析请求体。 - 使用
express.Router()
将相关路由进行模块化(例如,将所有/api/posts
相关的路由放在一个文件里)。 - 实现基本的错误处理,例如当找不到资源时返回 404 状态码,当请求格式错误时返回 400 状态码,当服务器内部错误时返回 500 状态码。
- (可选)添加
morgan
中间件记录请求日志。 - (可选)如果后续需要与前端结合,可以添加
cors
中间件。 - 使用 TypeScript (如果你在学习 TypeScript) 来增强代码的类型安全。需要配置
tsconfig.json
并使用tsc
编译。
实施步骤建议:
- 初始化 Node.js 项目 (
npm init -y
)。 - 安装 Express (
npm install express
) 和其他需要的包 (morgan
,cors
,typescript
,@types/express
,@types/morgan
,@types/cors
,@types/node
等)。 - 配置
tsconfig.json
(如果使用 TypeScript)。 - 创建主应用文件 (
app.js
或app.ts
),设置端口,创建 Express 实例,添加中间件。 - 创建路由文件目录 (
routes
) 和相应的路由文件 (posts.js
/posts.ts
或tasks.js
/tasks.ts
)。 - 在路由文件中定义 RESTful API 接口,处理请求,模拟数据的增删改查。
- 在主应用中挂载路由模块。
- 添加 404 和错误处理中间件。
- 运行应用 (
node app.js
或tsc && node dist/app.js
)。 - 使用工具(如 Postman, Insomnia,或者浏览器开发者工具)测试你的 API 接口。
完成这个项目,你将对后端开发流程和 Express 框架有更深入的理解,为后续学习数据库、用户认证等更高级的后端知识以及将前后端结合打下坚实基础。
至此,我们完成了 Node.js 和 Express 后端开发的基础学习。你已经掌握了如何让 JavaScript 运行在服务器端,使用核心模块处理文件和 HTTP 请求,以及使用 Express 框架构建结构化的 Web 应用和 RESTful API。这为你打开了通往全栈开发的大门!