第一节 node.js的第一个API

发布于:2025-07-23 ⋅ 阅读:(19) ⋅ 点赞:(0)

1. 需要安装的软件

你需要安装以下软件:

软件 作用 下载地址
Node.js 运行 JavaScript 的后端环境 https://nodejs.org
VS Code (推荐) 代码编辑器 https://code.visualstudio.com
Postman (可选) 测试 API 接口 https://www.postman.com

2. 安装 Node.js

  1. 进入 Node.js 官网
  2. 下载 LTS 版本(长期支持版,更稳定)。
  3. 安装时,一直点“下一步”即可(Windows/macOS)。
  4. 安装完成后,检查是否成功:
    • Windows:打开 cmd(命令提示符)。
    • Mac/Linux:打开 Terminal(终端)。
    • 输入:
      node -v
      npm -v
      

在这里插入图片描述


3. 创建第一个 Node.js API

(1) 创建项目文件夹

  1. 新建文件夹,例如 node.js
  2. 右键文件夹,选择 “用 VS Code 打开”(如果安装了 VS Code)。

(2) 初始化 Node.js 项目

  1. 在 VS Code 里,按 Ctrl + ~(或 Command + ~)打开终端。
  2. 输入:
    npm init -y
    
    • 这会生成 package.json 文件(记录项目信息)。
      在这里插入图片描述

(3) 安装 Express(最流行的 Node.js Web 框架)

在终端输入:

npm install express

在这里插入图片描述

(4) 创建 server.js 文件

  1. 在 VS Code 左侧文件栏,右键 → 新建文件,命名为 server.js
  2. 粘贴以下代码:
    const express = require('express');
    const app = express();
    const PORT = 3000;
    
    // 解析 JSON 请求(如 POST 请求的 body)
    app.use(express.json());
    
    // 定义第一个 API 路由(GET 请求)
    app.get('/', (req, res) => {
      res.send('Hello, 这是我的第一个 API!');
    });
    
    // 启动服务器
    app.listen(PORT, () => {
      console.log(`服务器运行在 http://localhost:${PORT}`);
    });
    

(5) 运行服务器

在终端输入:

node server.js
  • 如果看到 服务器运行在 http://localhost:3000,说明成功!
    在这里插入图片描述

(6) 测试 API

  1. 打开浏览器,访问:

    http://localhost:3000
    
    • 看到 Hello, 这是我的第一个 API!
    • 在这里插入图片描述
  2. 也可以用 Postman 测试:

    • 打开 Postman → 选择 GET → 输入 http://localhost:3000 → 点击 Send
      在这里插入图片描述

4. 进阶:添加 POST 接口

修改 server.js,添加一个 POST 接口:

// 1. 引入 express 模块
const express = require('express');

// 2. 创建 Express 应用实例
const app = express();

// 3. 添加中间件来解析 JSON 请求体
app.use(express.json());

// 模拟数据库
let users = [
  { id: 1, name: "张三" },
  { id: 2, name: "李四" }
];

// 获取所有用户(GET)
app.get('/api/users', (req, res) => {
  res.json(users);
});

// 新增用户(POST)
app.post('/api/users', (req, res) => {
  const newUser = {
    id: users.length + 1,
    name: req.body.name // 从请求体获取 name
  };
  users.push(newUser);
  res.status(201).json(newUser);
});

// 4. 启动服务器
const PORT = 3000;
app.listen(PORT, () => {
  console.log(`服务器运行在 http://localhost:${PORT}`);
});

测试 POST 接口

  1. 在 Postman 里:
    • 选择 POST → 输入 http://localhost:3000/api/users
    • 选择 BodyrawJSON
    • 输入:
      {
        "name": "王五"
      }
      
    • 点击 Send,可以看到返回新增的用户数据。
      在这里插入图片描述

5. 总结

安装 Node.js(运行 JavaScript 后端)
安装 VS Code(写代码)
初始化项目npm init -y
安装 Expressnpm install express
创建 server.js(编写 API 逻辑)
运行服务器node server.js
测试 API(浏览器或 Postman)

成功用 Node.js 写了一个简单的 API!🎉
接下来可以学习:

  • 连接数据库(如 MongoDB)
  • 使用 express.Router() 管理路由
  • 添加用户认证(如 JWT)

网站公告

今日签到

点亮在社区的每一天
去签到