所有文章 > 如何集成API > Node.js REST API 从入门到实践:GET、POST 与类封装完整指南
Node.js REST API 从入门到实践:GET、POST 与类封装完整指南

Node.js REST API 从入门到实践:GET、POST 与类封装完整指南

一. Node.js REST API 入门

在现代 Web 开发中,掌握如何在 Node.js 中创建 REST API(表述性状态转移应用程序接口)是一项重要技能。REST API 允许客户端(如 Web 应用)通过无状态操作与服务器交互。本教程将带你从零开始,在 Node.js 中构建一个简单的 REST API,并通过数据类型、类及 HTTP 方法示例进行演示。


二. 初始化项目

首先,为项目创建目录并初始化 Node.js 项目:

mkdir my-rest-api
cd my-rest-api
npm init -y

上述命令将在目录中生成 package.json 文件,用于管理依赖关系。

接着,安装 Express 以简化 HTTP 请求处理:

npm install express

三. 创建基本服务器

在项目目录中创建 index.js 文件,作为项目入口。以下是基础 Express 服务器代码示例:

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

app.listen(3000, () => {
  console.log("Server running on port 3000");
});

此代码创建了一个在端口 3000 上运行的服务器。


四. 添加 GET 端点

REST API 使用不同 HTTP 方法,其中最常用的是 GET、POST、PUT 和 DELETE。以下是 GET 示例,用于返回简单消息:

app.get("/msg", (req, res, next) => {
  res.json({ "message": "Hello, World!" });
});

访问 http://localhost:3000/msg 即可查看返回的 JSON 数据。


五. 添加 POST 端点

POST 请求用于接收客户端数据。示例代码如下:

app.use(express.json()); // 解析 application/json 请求体

app.post("/msg", (req, res, next) => {
  const message = req.body.message;
  res.json({ "receivedMessage": message });
});

发送 JSON 数据到 http://localhost:3000/msg,即可接收响应。


六. 使用类优化代码

为了组织逻辑,可以使用类封装操作。例如:

class Message {
  constructor(content) {
    this.content = content;
  }

  getContent() {
    return this.content;
  }
}

app.post("/msg", (req, res, next) => {
  const newMessage = new Message(req.body.message);
  res.json({ "receivedMessage": newMessage.getContent() });
});

这种方法提高了代码可维护性,并便于扩展功能。


七. 测试 API

可以使用 Postman 或 cURL 测试 API:

  • GET 请求:在浏览器访问 http://localhost:3000/msg
  • POST 请求:在 Postman 中发送 JSON 数据到 http://localhost:3000/msg

八. 总结与扩展

在 Node.js 中创建 REST API 是直观的。使用 Express,可以轻松处理各种 HTTP 方法,而类和数据结构能提升代码可读性和可维护性。

进一步扩展 API 功能可考虑:

  • 添加复杂路由和参数
  • 连接数据库(如 MongoDBPostgreSQL
  • 实现用户认证与授权

持续实践与优化,将帮助你构建功能丰富、高效的 REST API。


原文链接: https://medium.com/@holasoymalva/how-to-make-your-first-rest-api-in-node-js-82c05fca9106

#你可能也喜欢这些API文章!

我们有何不同?

API服务商零注册

多API并行试用

数据驱动选型,提升决策效率

查看全部API→
🔥

热门场景实测,选对API

#AI文本生成大模型API

对比大模型API的内容创意新颖性、情感共鸣力、商业转化潜力

25个渠道
一键对比试用API 限时免费

#AI深度推理大模型API

对比大模型API的逻辑推理准确性、分析深度、可视化建议合理性

10个渠道
一键对比试用API 限时免费