Node.js 中建立 API 的初學者指南：簡潔且可擴展-js教程-PHP中文網

Beginner

Node.js REST API 架構入門指南

本指南將幫助您學習如何建立結構清晰的 Node.js REST API。包含資料夾組織、最佳實務以及建立可擴充、易維護 API 的技巧。

Node.js REST API 架構入門指南
- 目錄
- Node.js API 架構簡介
- 為什麼 API 架構很重要？
- API 架構的核心概念
- 基礎 API 資料夾結構
- 分步說明
  - 1. server.js
  - 1. 環境變數 (.env)
  - 1. 路由
  - 1. 控制器
  - 1. 模型
  - 1. 配置
- 最佳實踐
- 真實案例
- 總結
- 結語與回饋 ?
- 保持聯繫 ?

Node.js API 架構簡介

API 是現代 Web 應用程式的基石，連接前端和伺服器。然而，結構不良的 API 會導致程式碼混亂且難以維護。對於剛接觸 Node.js 的初學者來說，從一開始就理解如何組織專案對於建立可擴展、簡潔的應用程式至關重要。

本指南將引導您了解 Node.js REST API 的基本架構。我們將涵蓋基本要素、最佳實踐，並提供一個實用的資料夾結構，您可以將其應用到您的專案中。閱讀更多關於資料夾結構的資訊

為什麼 API 架構很重要？

在開始時，許多開發人員將所有內容放入一個文件中。雖然這對於小型專案有效，但隨著程式碼庫的成長，它會變成一場噩夢。良好的 API 結構有助於：

可維護性: 讓尋找和修改程式碼更容易。
可擴充性: 允許您的應用程式在不中斷的情況下成長。
協作性: 幫助團隊快速理解程式碼。
可讀性: 清晰的程式碼更容易偵錯和擴充。

API 架構的核心概念

在深入探討資料夾結構之前，讓我們先了解一些基本原則：

關注點分離: 將應用程式的不同部分（例如，路由、資料庫、邏輯）保存在單獨的檔案中，以避免職責混淆。
模組化: 將程式碼分解成可重複使用的模組。
環境變數: 使用 .env 檔案安全地儲存敏感數據，例如資料庫憑證。

基礎 API 資料夾結構

這是一個適用於小型專案的簡單結構，非常適合絕對初學者：

<code>my-api/
├── server.js          # 入口点
├── package.json       # 项目元数据和依赖项
├── .env               # 环境变量
├── /routes            # API 路由定义
│   └── userRoutes.js  # 示例：用户相关的路由
├── /controllers       # 请求处理逻辑
│   └── userController.js
├── /models            # 数据库模型或模式
│   └── userModel.js
└── /config            # 配置文件
    └── db.js          # 数据库连接设置</code>

登入後複製

分步說明

1. server.js

應用程式的入口點：

設定 Express 伺服器。
載入中間件和路由。

<code>my-api/
├── server.js          # 入口点
├── package.json       # 项目元数据和依赖项
├── .env               # 环境变量
├── /routes            # API 路由定义
│   └── userRoutes.js  # 示例：用户相关的路由
├── /controllers       # 请求处理逻辑
│   └── userController.js
├── /models            # 数据库模型或模式
│   └── userModel.js
└── /config            # 配置文件
    └── db.js          # 数据库连接设置</code>

登入後複製

2. 環境變數 (.env)

使用 .env 檔案儲存敏感資料：

<code class="language-javascript">require('dotenv').config();
const express = require('express');
const userRoutes = require('./routes/userRoutes');
const connectDB = require('./config/db');

const app = express();
const PORT = process.env.PORT || 5000;

// 中间件
app.use(express.json());

// 数据库连接
connectDB();

// 路由
app.use('/api/users', userRoutes);

app.listen(PORT, () => console.log(`服务器运行在端口 ${PORT}`));</code>

登入後複製

安裝 dotenv 將這些變數載入 process.env 中：

<code>PORT=5000
MONGO_URI=mongodb+srv://username:password@cluster.mongodb.net/myDatabase</code>

登入後複製

3. 路由

路由處理 HTTP 請求並將它們指向對應的控制器。

/routes/userRoutes.js:

<code class="language-bash">npm install dotenv</code>

登入後複製

4. 控制器

控制器包含處理請求的邏輯。

/controllers/userController.js:

<code class="language-javascript">const express = require('express');
const { getAllUsers, createUser } = require('../controllers/userController');
const router = express.Router();

// 获取所有用户
router.get('/', getAllUsers);

// POST 创建新用户
router.post('/', createUser);

module.exports = router;</code>

登入後複製

5. 模型

模型定義資料庫文件的結構。在這個範例中，我們使用 MongoDB 和 Mongoose。

/models/userModel.js:

<code class="language-javascript">const User = require('../models/userModel');

// 获取所有用户
const getAllUsers = async (req, res) => {
  try {
    const users = await User.find();
    res.status(200).json(users);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
};

// POST 创建新用户
const createUser = async (req, res) => {
  try {
    const { name, email } = req.body;
    const newUser = await User.create({ name, email });
    res.status(201).json(newUser);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
};

module.exports = { getAllUsers, createUser };</code>

登入後複製

6. 配置

設定資料夾包含連接到外部資源（例如資料庫）的檔案。

/config/db.js:

<code class="language-javascript">const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true }
});

module.exports = mongoose.model('User', userSchema);</code>

登入後複製