Node.js의 API 구조화를 위한 초보자 가이드: 정리 및 확장 가능-JS 튜토리얼-php.cn

Node.js REST API 아키텍처 시작 가이드
- 목차
- Node.js API 아키텍처 소개
- API 아키텍처가 왜 중요한가요?
- API 아키텍처의 핵심 개념
- 기본 API 폴더 구조
- 단계별 지침
  - 1. server.js
  - 1. 환경변수(.env)
  - 1. 라우팅
  - 1. 컨트롤러
  - 1. 모델
  - 1. 구성
- 모범 사례
- 실제 사례
- 요약
- 결론과 피드백은?
- 연락을 유지하세요 ?

Node.js API 아키텍처 소개

API는 프런트엔드와 서버를 연결하는 최신 웹 애플리케이션의 초석입니다. 그러나 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. 서버.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 파일을 사용하여 민감한 데이터 저장:

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, () =&gt; console.log(`服务器运行在端口 ${PORT}`));

로그인 후 복사

dotenv를 설치하여 이러한 변수를 process.env에 로드하세요.

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

로그인 후 복사

3. 라우팅

경로는 HTTP 요청을 처리하고 이를 적절한 컨트롤러로 전달합니다.

/routes/userRoutes.js:

npm install dotenv

로그인 후 복사

4. 컨트롤러

컨트롤러에는 요청을 처리하는 로직이 포함되어 있습니다.

/controllers/userController.js:

const express = require('express');
const { getAllUsers, createUser } = require('../controllers/userController');
const router = express.Router();

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

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

module.exports = router;

로그인 후 복사

5. 모델

모델은 데이터베이스 문서의 구조를 정의합니다. 이 예에서는 MongoDB와 Mongoose를 사용합니다.

/models/userModel.js:

const User = require('../models/userModel');

// 获取所有用户
const getAllUsers = async (req, res) =&gt; {
  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) =&gt; {
  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 };

로그인 후 복사

6. 구성

구성 폴더에는 데이터베이스와 같은 외부 리소스에 연결하는 파일이 포함되어 있습니다.

/config/db.js:

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);

로그인 후 복사

모범 사례

코드를 건조하게 유지하세요(반복하지 마세요) : 가능하면 함수와 모듈을 재사용하지 마세요.
오류 처리: 오류를 적절하게 처리하려면 항상 try-catch 블록이나 미들웨어를 사용하세요.
미들웨어 사용: 인증, 요청 확인, 로깅 등의 작업에 사용됩니다.
API 버전 관리: 버전 관리(/api/v1/users)를 사용하면 이전 클라이언트를 손상시키지 않고 향후 업데이트를 처리할 수 있습니다.