[작성자:] root

Express 개발 강좌, Swagger 또는 Postman을 이용한 API 문서화

웹 애플리케이션에서 API는 중요한 역할을 합니다. 특히, 백엔드 개발에서는 API를 통해 클라이언트와 서버 간의 통신을 원활하게 이루어질 수 있게 합니다. 따라서, API 문서화는 팀원 간의 이해를 높이고, 유지 보수를 용이하게 하는 중요한 작업입니다. 오늘은 Express.js 백엔드 서버를 개발하며 Swagger와 Postman을 이용해 API 문서화하는 방법에 대해 알아보겠습니다.

1. Express.js 소개

Express.js는 Node.js를 위한 최소화된 웹 프레임워크로, 웹 애플리케이션과 APIs를 개발하는 데 사용됩니다. Express는 다양한 미들웨어와 라우팅 기능을 제공하여 개발자가 효율적으로 웹 애플리케이션을 구축할 수 있도록 도와줍니다.

2. Express 프로젝트 설정

bash
# Express 프로젝트 생성
mkdir express-api-demo
cd express-api-demo
npm init -y
npm install express

위 명령어를 사용하여 Express 프로젝트를 생성하고, Express.js 패키지를 설치합니다.

2.1 기본 서버 설정

javascript
const express = require('express');
const app = express();
const PORT = 3000;

app.get('/', (req, res) => {
    res.send('Hello, Express!');
});

app.listen(PORT, () => {
    console.log(`Server is running on http://localhost:${PORT}`);
});

이제 기본 Express 서버가 설정되었습니다. npm start로 서버를 실행하면 http://localhost:3000에서 “Hello, Express!” 메시지를 볼 수 있습니다.

3. Swagger를 이용한 API 문서화

Swagger는 RESTful API의 설계, 문서화 및 테스트를 위한 통합 솔루션입니다. Swagger UI는 API를 시각적으로 표현하여 개발자와 비개발자가 쉽게 이해할 수 있도록 도와줍니다. 이제 Swagger를 Express 프로젝트에 통합하는 방법을 살펴보겠습니다.

3.1 Swagger UI와 Swagger JSDoc 설치

bash
npm install swagger-ui-express swagger-jsdoc

3.2 Swagger 설정

Swagger를 설정하기 위해 아래와 같이 코드를 수정합니다.

javascript
const swaggerJsDoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const swaggerOptions = {
    swaggerDefinition: {
        openapi: '3.0.0',
        info: {
            title: 'Express API Demo',
            version: '1.0.0',
            description: 'API documentation for Express Demo',
        },
        servers: [
            {
                url: 'http://localhost:3000',
            },
        ],
    },
    apis: ['./routes/*.js'], // API 문서화할 파일 경로
};

const swaggerDocs = swaggerJsDoc(swaggerOptions);
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));

3.3 API 문서화 주석 추가

Swagger에서 API를 문서화하기 위해 각 API 함수 위에 JSDoc 주석을 추가해야 합니다. 다음은 간단한 GET API에 대한 예입니다.

javascript
/**
 * @swagger
 * /:
 *   get:
 *     summary: Returns a Hello message
 *     responses:
 *       200:
 *         description: A Hello message
 */
app.get('/', (req, res) => {
    res.send('Hello, Express!');
});

이제 서버를 다시 실행하고 http://localhost:3000/api-docs로 이동하면 Swagger UI를 통해 API 문서를 확인할 수 있습니다.

4. Postman을 이용한 API 테스트 및 문서화

Postman은 API를 테스트하고 문서화하는 데 널리 사용되는 도구입니다. Postman을 사용하여 API를 쉽게 테스트하고, 테스트 결과를 문서화하는 방법을 알아보겠습니다.

4.1 Postman 설치

Postman은 공식 웹사이트에서 다운받아 설치할 수 있습니다. 설치 후 애플리케이션을 열고 API 요청을 생성할 수 있습니다.

4.2 API 요청 만들기

Postman에서 새 요청을 만들고, HTTP 메서드와 URL을 입력하여 API 요청을 구성합니다. 아래는 GET 요청의 예입니다.

plaintext
Method: GET
URL: http://localhost:3000/

4.3 요청 테스트 및 응답 확인

위와 같이 요청을 구성한 후, Send 버튼을 클릭하여 요청을 전송합니다. 올바르다면 “Hello, Express!”라는 응답을 확인할 수 있습니다.

4.4 API 문서화

Postman은 요청이 성공적으로 완료된 후, 요청 정보를 문서화할 수 있는 기능을 제공합니다. 요청을 선택한 뒤 우측 상단의 ... 메뉴에서 Save as Template을 선택하여 요청 정보를 저장할 수 있습니다.

5. API 문서화의 중요성

API 문서화는 개발자의 생산성을 높이고, 유지 보수를 용이하게 만들며, 팀과의 협업을 촉진합니다. Swagger와 Postman은 이러한 문서화 과정을 간소화해주며, 팀원들이 API의 작동 방식을 쉽게 이해할 수 있도록 도와줍니다.

6. 결론

오늘 우리는 Express.js를 사용한 간단한 API 서버를 설정하고, Swagger와 Postman을 통해 API를 문서화하는 방법을 알아보았습니다. 이 과정에서 얻은 지식을 바탕으로, 앞으로 더욱 효율적으로 API를 개발하고 문서화할 수 있기를 바랍니다.

참고 자료

Express 개발 강좌, CORS의 개념과 필요성

1. CORS란 무엇인가?

CORS(Cross-Origin Resource Sharing)는 웹 브라우저에서 실행되는 웹 애플리케이션이 자신의 출처(origin)와 다른 출처에 있는 자원에 접근할 수 있도록 허용하는 메커니즘입니다. 출처란 프로토콜(예: http, https), 호스트(도메인), 포트 번호의 조합입니다. 예를 들어, https://example.com과 https://api.example.com은 다른 출처로 간주됩니다.

2. CORS의 필요성

기본적으로 웹 브라우저는 보안 상의 이유로 서로 다른 출처 간의 요청을 제한합니다. 이는 XSS(교차 사이트 스크립팅) 공격 및 CSRF(교차 사이트 요청 위조)와 같은 보안 위협으로부터 사용자를 보호하기 위한 것입니다. 따라서, CORS는 웹 애플리케이션이 안전하게 다양한 출처의 리소스에 접근할 수 있도록 하는 규칙을 정의합니다.

2.1 CORS의 동작 원리

CORS는 HTTP 헤더를 통해 작동합니다. 서버는 요청을 받은 후 클라이언트의 요청 출처를 검증하고, 필요에 따라 적절한 CORS 헤더를 추가하여 응답합니다. 주요 CORS 헤더는 다음과 같습니다:

  • Access-Control-Allow-Origin: 허용된 출처를 지정합니다.
  • Access-Control-Allow-Methods: 허용된 HTTP 메소드를 명시합니다.
  • Access-Control-Allow-Headers: 허용된 요청 헤더를 지정합니다.
  • Access-Control-Expose-Headers: 클라이언트가 접근할 수 있는 헤더를 정의합니다.

2.2 CORS의 실제 동작 예시

클라이언트가 CORS 요청을 보낼 때, 브라우저는 먼저 OPTIONS 메소드를 사용하여 Preflight 요청을 수행합니다. 서버는 이 요청에 대한 응답으로 CORS 헤더를 포함하여 클라이언트가 실제 요청을 진행할 수 있는지 여부를 확인합니다.

3. Express에서 CORS 설정하기

Express에서는 cors 미들웨어를 사용하여 CORS를 쉽게 설정할 수 있습니다. 먼저 cors 패키지를 설치해야 합니다:

npm install cors

3.1 기본적인 사용법

설치 후, Express 애플리케이션에 cors 미들웨어를 추가하여 모든 출처에 대해 CORS 요청을 허용할 수 있습니다.

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

const app = express();

// CORS 미들웨어 사용
app.use(cors());

app.get('/api/data', (req, res) => {
    res.json({ message: 'CORS 설정 성공!' });
});

app.listen(3000, () => {
    console.log('서버가 3000번 포트에서 실행 중입니다.');
});

3.2 특정 출처에 대한 CORS 설정

특정 출처에 대해서만 CORS 요청을 허용하고 싶다면, cors 미들웨어에 설정 객체를 전달하면 됩니다. 아래 코드는 https://example.com에서 오는 요청만 허용하는 예제입니다.

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

const app = express();

// 특정 출처에 대해서만 CORS 허용
const allowedOrigins = ['https://example.com'];

app.use(cors({
    origin: function(origin, callback){
        // 출처가 없는 경우 (예: 로컬 요청) 허용
        if(!origin) return callback(null, true);
        if(allowedOrigins.indexOf(origin) === -1){
            const msg = 'CORS 정책에 의해 접근이 거부되었습니다.';
            return callback(new Error(msg), false);
        }
        return callback(null, true);
    }
}));

app.get('/api/data', (req, res) => {
    res.json({ message: '특정 출처 CORS 설정 성공!' });
});

app.listen(3000, () => {
    console.log('서버가 3000번 포트에서 실행 중입니다.');
});

4. CORS의 보안 고려사항

CORS를 설정할 때 주의해야 할 점은, 너무 많은 출처를 허용할 경우 보안에 취약해질 수 있다는 점입니다. 접근을 허용하는 출처를 엄격히 관리하고, 특히 민감한 데이터에 대한 접근은 신중하게 설정해야 합니다.

5. CORS 에러 처리

CORS가 설정되지 않았거나 잘못 설정된 경우 브라우저는 CORS 에러를 발생시킵니다. 이러한 에러는 일반적으로 콘솔에서 확인할 수 있으며, 개발자는 서버의 CORS 설정을 적절히 수정하여 문제를 해결해야 합니다.

6. 결론

CORS는 현대 웹 애플리케이션 개발에서 필수적인 요소입니다. 웹 보안을 강화하면서도, 다양한 출처의 리소스에 안전하게 접근할 수 있도록 해주기 때문에 개발자는 CORS의 개념과 설정 방법을 잘 이해하고 활용해야 합니다.

Express 애플리케이션을 구축할 때 CORS는 꼭 설정해야 할 사항이며, 위의 예제 코드를 통해 쉽게 적용할 수 있습니다. 항상 보안을 염두에 두고, 필요한 출처만 허용하는 철저한 정책을 유지하시길 바랍니다.

Express 개발 강좌, Heroku, Vercel, AWS 등을 이용한 서버 배포 방법

웹 개발의 많은 부분이 서버 사이드 기술과 그 배포에 의존하고 있습니다. 이 강좌에서는 Express.js를 사용하여 백엔드 서버를 구축하고, 이를 Heroku, Vercel, 그리고 AWS 등 다양한 플랫폼에 배포하는 방법을 자세히 설명하겠습니다. 이 과정은 전체적인 워크플로우를 이해하는 데 도움이 되며, 좋은 개발 습관을 기르는 데 중요한 기초가 될 것입니다.

1. Express.js란?

Express.js는 Node.js 환경에서 작동하는 웹 애플리케이션 프레임워크로, 간단하고 유연한 API를 제공하여 개발자가 RESTful 웹 서비스를 쉽게 구축할 수 있게 돕습니다. 경량이며, 다양한 미들웨어와의 통합이 용이해 많은 개발자들이 선택하는 프레임워크입니다.

2. Express.js로 서버 구축하기

2.1. 기본 설정

먼저, Node.js와 npm이 설치되어 있는지 확인합니다. 그런 다음 새로운 프로젝트를 시작하여 필요한 패키지를 설치합니다. 


            mkdir express-backend
            cd express-backend
            npm init -y
            npm install express

2.2. 간단한 서버 만들기

다음으로, Express.js를 사용하여 기본적인 서버를 만들어 보겠습니다. 


            const express = require('express');
            const app = express();
            const PORT = process.env.PORT || 3000;

            app.get('/', (req, res) => {
                res.send('Hello World!');
            });

            app.listen(PORT, () => {
                console.log(`Server is running on http://localhost:${PORT}`);
            });

위 코드는 기본적인 Express 서버를 설정합니다. `/` 경로로 요청을 보내면 “Hello World!” 메시지를 응답합니다. 서버는 기본적으로 포트 3000에서 실행됩니다.

3. 서버 배포 방법

Express 서버를 지역 환경에서 성공적으로 실행했다면, 이제는 클라우드 환경에 배포해야 합니다. 이 섹션에서는 Heroku, Vercel, 그리고 AWS를 이용한 배포 방법을 알아보겠습니다.

3.1. Heroku에 배포하기

3.1.1. Heroku CLI 설치

Heroku에 배포하기 위해서는 Heroku CLI를 설치해야 합니다. 아래 링크에서 설치 방법을 확인할 수 있습니다.
Heroku CLI 설치하기

3.1.2. Heroku로 앱 생성하기

터미널에서 아래의 명령어를 실행하여 새로운 Heroku 앱을 생성합니다. 


            heroku create your-app-name

3.1.3. 코드 조정

Heroku에서는 포트를 환경 변수로 관리하므로, 코드에서 포트를 설정하는 부분을 수정합니다. 


            const PORT = process.env.PORT || 3000;

3.1.4. 배포

코드를 Heroku에 배포하기 위해 Git을 사용하여 코드를 커밋한 후, 아래 명령어를 통해 푸시합니다. 


            git add .
            git commit -m "Initial commit"
            git push heroku master

3.1.5. 배포 확인

배포가 완료되면 아래 명령어를 통해 애플리케이션을 열 수 있습니다. 


            heroku open

3.2. Vercel에 배포하기

3.2.1. Vercel CLI 설치

Vercel에 배포하기 위해 Vercel CLI를 설치합니다. 아래 링크를 따라 설치합니다.
Vercel 다운로드

3.2.2. Vercel로 프로젝트 배포하기

프로젝트 루트 디렉토리에서 Vercel CLI를 사용하여 배포합니다. 


            vercel

3.2.3. 환경 변수 설정

Vercel 대시보드에서 환경 변수를 설정할 수 있으며, 포트 설정도 마찬가지로 환경 변수에 의해 관리됩니다.

3.3. AWS에 배포하기

3.3.1. AWS 계정 생성

AWS에서 배포하기 위해서는 AWS 계정을 생성해야 합니다. AWS 공식 사이트에서 계정을 생성합니다.

3.3.2. EC2 인스턴스 만들기

AWS Management Console에 로그인한 후 EC2 대시보드로 이동합니다. “Launch Instance” 버튼을 클릭하여 새로운 인스턴스를 생성합니다. 보안 그룹에서 HTTP(포트 80)와 SSH(포트 22) 접근을 허용합니다.

3.3.3. 서버 설정

SSH를 통해 EC2 서버에 접속한 뒤 Node.js와 필요한 패키지를 설치합니다. 


            sudo apt update
            sudo apt install nodejs npm

3.3.4. 코드 올리기

로컬 서버에서 작성한 코드를 SCP를 통해 EC2 인스턴스로 복사합니다. 


            scp -i your-key.pem -r ./express-backend/ ec2-user@your-ec2-ip-address:/home/ec2-user/

3.3.5. 서버 실행

SSH로 EC2에 연결한 후, 애플리케이션 디렉토리로 이동하여 서버를 실행합니다. 


            cd express-backend
            node app.js

3.3.6. 도메인 설정

공인 IP 주소 또는 도메인을 사용하여 애플리케이션에 접근할 수 있습니다. Route 53을 사용하여 도메인을 설정할 수 있습니다.

4. 배포 후 유지 관리

배포가 완료된 후에는 애플리케이션의 성능과 안정성을 지속적으로 모니터링하는 것이 중요합니다. 또한, 필요할 경우 애플리케이션을 업데이트하고 보안을 유지해야 합니다.

5. 결론

이번 강좌에서는 Express.js를 사용하여 서버를 구축하고, Heroku, Vercel, AWS와 같은 다양한 플랫폼에 배포하는 방법을 배웠습니다. 각 클라우드 서비스마다 운영 방식과 배포 가능성은 다릅니다. 본인의 프로젝트와 요구 사항에 맞는 플랫폼을 선택하여 배포하세요.

추가 자료나 샘플 코드는 GitHub에 업로드해두었으니 참고하시기 바랍니다. 귀하의 서버 배포 경험이 더 풍부해지길 바랍니다!

Express 개발 강좌, RESTful API란 무엇인가 설계 원칙

현대 웹 개발에서 RESTful API는 서버와 클라이언트 간의 원활한 데이터 전송 및 상호작용을 위해 필수적인 개념입니다. Express.js는 Node.js 환경에서 RESTful API를 구축하기 위한 간편하고 강력한 프레임워크로 자리잡았습니다. 이번 글에서는 RESTful API의 개념, 설계 원칙, 그리고 Express를 사용한 예제 코드를 통해 이를 이해해 보겠습니다.

1. RESTful API란?

REST(Representational State Transfer)는 웹 아키텍처 스타일 중 하나로, HTTP 프로토콜을 기반으로 합니다. RESTful API는 이러한 REST의 원칙을 준수하여 클라이언트와 서버가 통신하는 방식입니다. RESTful API를 사용하면 다양한 클라이언트가 서버의 자원에 접근하고 상호작용할 수 있으며, 이 자원은 URI(Uniform Resource Identifier)를 통해 식별됩니다.

1.1. REST의 주요 특징

  • 무상태성(Stateless): 각 요청은 독립적이며, 서버는 클라이언트의 상태를 저장하지 않습니다.
  • 자원 기반(Resource-Based): 자원은 URI로 식별되며, HTTP 메소드를 통해 자원에 대한 CRUD(Create, Read, Update, Delete) 작업을 수행합니다.
  • 표현(Representation): 클라이언트와 서버 간의 데이터 교환은 주로 JSON, XML 등의 형식으로 이루어집니다.
  • 캐시 가능(Cacheable): 응답은 캐시 가능하므로 클라이언트는 동일한 자원에 대한 후속 요청을 삭제할 수 있습니다.

2. RESTful API의 설계 원칙

RESTful API를 설계할 때 준수해야 할 몇 가지 원칙이 있습니다. 이는 API의 일관성과 사용성을 보장하는 데 도움이 됩니다.

2.1. 자원(URL)의 설계

RESTful API는 자원 중심으로 설계되어야 하며, 각 자원은 고유한 URI로 식별됩니다. URI는 의미론적으로 이해할 수 있어야 하며, 다음과 같은 규칙을 따릅니다:

  • 복수형을 사용하여 자원을 표현합니다: 예를 들어, 사용자를 나타내는 자원은 /users로 표현합니다.
  • 계층적 구조로 설계합니다: 자원 간의 관계를 고려하여 URI를 설계합니다. 예를 들어, 특정 사용자의 포스트를 나타내는 자원은 /users/:userId/posts로 표현할 수 있습니다.

2.2. HTTP 메소드의 활용

자원에 대한 작업은 다음의 HTTP 메소드를 사용하여 수행합니다:

  • GET: 자원 조회 (ex. GET /users)
  • POST: 자원 생성 (ex. POST /users)
  • PUT: 자원 전체 업데이트 (ex. PUT /users/:userId)
  • PATCH: 자원 부분 업데이트 (ex. PATCH /users/:userId)
  • DELETE: 자원 삭제 (ex. DELETE /users/:userId)

2.3. 상태 코드의 활용

HTTP 상태 코드는 클라이언트에게 요청 처리 결과를 전달하는 데 필요합니다. 다음은 자주 사용되는 상태 코드입니다:

  • 200 OK: 성공적인 요청
  • 201 Created: 자원 생성 성공
  • 204 No Content: 요청 성공, 반환할 데이터 없음
  • 400 Bad Request: 잘못된 요청
  • 404 Not Found: 자원 없음
  • 500 Internal Server Error: 서버 에러

2.4. 버전 관리

API가 진화함에 따라 기존의 API와 호환되지 않는 변경이 있을 수 있습니다. 따라서 API 버전을 명시하여 클라이언트가 특정 버전을 사용하도록 합니다. 일반적으로 URL에 버전 번호를 포함시킵니다:

/v1/users

3. Express.js를 이용한 RESTful API 구축

이제 Express.js를 사용하여 간단한 RESTful API를 구축해 보겠습니다. 이 예제에서는 사용자 정보를 관리하는 API를 구현합니다.

3.1. Express 프로젝트 설정

먼저, Express 프로젝트를 생성합니다. Node.js가 설치되어 있어야 하며, 새로운 프로젝트를 만들고 필요한 패키지를 설치합니다:

mkdir express-api-example
cd express-api-example
npm init -y
npm install express body-parser

3.2. 기본 서버 설정

아래의 코드로 server.js 파일을 생성하고 기본 Express 서버를 설정합니다:

const express = require('express');
const bodyParser = require('body-parser');

const app = express();
const PORT = 3000;

// Middleware
app.use(bodyParser.json());

// 기본 라우터
app.get('/', (req, res) => {
    res.send('Welcome to the Express RESTful API!');
});

// 서버 실행
app.listen(PORT, () => {
    console.log(`Server is running on http://localhost:${PORT}`);
});

3.3. RESTful API 엔드포인트 생성

이제 사용자 정보를 관리하기 위한 CRUD 엔드포인트를 추가해 보겠습니다.


// 가상의 사용자 데이터를 저장하기 위한 배열
let users = [];

// GET: 사용자 목록 조회
app.get('/users', (req, res) => {
    res.json(users);
});

// GET: 특정 사용자 조회
app.get('/users/:userId', (req, res) => {
    const user = users.find(u => u.id === parseInt(req.params.userId));
    if (!user) return res.status(404).send('User not found');
    res.json(user);
});

// POST: 사용자 추가
app.post('/users', (req, res) => {
    const user = {
        id: users.length + 1,
        name: req.body.name,
        email: req.body.email
    };
    users.push(user);
    res.status(201).json(user);
});

// PUT: 사용자 정보 수정
app.put('/users/:userId', (req, res) => {
    let user = users.find(u => u.id === parseInt(req.params.userId));
    if (!user) return res.status(404).send('User not found');
    
    user.name = req.body.name;
    user.email = req.body.email;
    res.json(user);
});

// DELETE: 사용자 삭제
app.delete('/users/:userId', (req, res) => {
    users = users.filter(u => u.id !== parseInt(req.params.userId));
    res.status(204).send();
});

3.4. 서버 실행 및 테스트

서버를 실행합니다:

node server.js

브라우저나 Postman과 같은 API 클라이언트를 사용하여 엔드포인트를 테스트할 수 있습니다.

4. API 문서화

RESTful API를 개발한 후에는 문서화가 필요합니다. 문서화는 API 사용자가 API를 쉽게 이해하고 사용할 수 있도록 도와줍니다. Swagger, Postman과 같은 도구를 사용하여 쉽게 문서화할 수 있습니다. Swagger UI를 사용하면 API 문서를 시각적으로 작성할 수 있습니다.

5. 결론

이번 글에서는 Express.js를 사용한 RESTful API의 개념과 설계 원칙을 살펴보았습니다. RESTful API는 웹 애플리케이션의 필수적인 부분이며, Express.js를 사용하여 간단하고 효율적으로 구축할 수 있습니다. 설계 원칙을 지킴으로써 사용자는 API를 더욱 쉽게 활용할 수 있습니다. 이러한 원칙을 바탕으로 여러분의 프로젝트에 적합한 RESTful API를 구축해 보시기 바랍니다.

6. 참고 자료

Express 개발 강좌, 미들웨어의 개념과 필요성

Express.js는 Node.js 기반의 웹 애플리케이션 프레임워크로, 웹 서버 및 API를 신속하게 개발할 수 있도록 도와줍니다. Express의 가장 큰 장점 중 하나는 바로 ‘미들웨어’ 개념에 있습니다. 이번 강좌에서는 미들웨어의 정의, 필요성, 사용 방법 및 간단한 예제를 통해 이해를 돕도록 하겠습니다.

1. 미들웨어란 무엇인가?

미들웨어는 Express 애플리케이션에서 요청과 응답 사이에 위치한 함수의 집합입니다. 클라이언트의 요청이 서버에 도달했을 때, 요청 객체(req), 응답 객체(res), 그리고 다음 미들웨어 함수(next)를 인수로 받아들입니다. 미들웨어는 특정 작업을 수행한 후, 다음 미들웨어로 요청을 전달할 수 있습니다.

예를 들어, 인증, 로깅, 데이터 파싱, 에러 처리 등과 같은 다양한 기능을 미들웨어를 통해 손쉽게 구현할 수 있습니다.

1.1. 미들웨어의 동작 방식

미들웨어는 요청 처리의 파이프라인을 형성합니다. 클라이언트의 요청이 들어오면, Express는 등록된 미들웨어를 순서대로 실행합니다. 이 때, 미들웨어는 다음 미들웨어를 호출할 수 있게 해주는 next() 함수를 가지고 있으며, 이를 호출하지 않으면 요청 처리가 중단됩니다.

1.2. 미들웨어의 종류

  • 애플리케이션 미들웨어: app.use()를 통해 등록된 미들웨어로, 애플리케이션 레벨에서 동작합니다.
  • 라우터 미들웨어: 특정 라우터에 적용되는 미들웨어로, app.Router()를 통해 등록합니다.
  • 내장 미들웨어: Express에 내장된 미들웨어로, bodyParser와 cookieParser 등이 있습니다.
  • 제3자 미들웨어: Express 외부에서 제공되는 미들웨어로, morgan, cors 등을 포함합니다.

2. 미들웨어의 필요성

미들웨어는 웹 애플리케이션의 요청 처리를 구조화하고, 코드의 재사용성을 높이며, 유지보수를 용이하게 만들어줍니다. 많은 기능을 모듈화하여 관리할 수 있기 때문에, 대규모 애플리케이션에서도 일관된 방식으로 요청을 처리할 수 있습니다.

2.1. 코드의 모듈화

미들웨어를 사용하면 기능을 모듈화 할 수 있어 각 미들웨어가 특정 책임을 가지고 작동하게 됩니다. 예를 들어, 인증 미들웨어는 요청이 들어올 때마다 인증을 검사하고, 로깅 미들웨어는 각 요청의 세부사항을 로그에 기록할 수 있습니다. 이러한 분리는 코드를 이해하기 쉽게 하고, 테스트 모듈화 및 재사용을 높입니다.

2.2. 요청과 응답의 체계적인 처리

미들웨어는 요청과 응답의 중간 단계에서 추가 처리를 가능하게 해줍니다. 예를 들어, 사용자의 인증 상태에 따라 요청을 리다이렉트하거나, 요청 데이터를 검증하여 잘못된 데이터에 대한 에러를 반환할 수 있습니다.

3. 미들웨어 사용 방법

미들웨어 설정은 매우 간단합니다. Express 애플리케이션을 생성하고, app.use() 메서드를 사용하여 미들웨어를 추가하면 됩니다.

3.1. 기본 미들웨어 작성하기

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

// 일반적인 미들웨어 예제
app.use((req, res, next) => {
    console.log(`${req.method} 요청을 받았습니다: ${req.url}`);
    next(); // 다음 미들웨어로 넘김
});

app.get('/', (req, res) => {
    res.send('안녕하세요, Express!');
});

app.listen(3000, () => {
    console.log('서버가 3000포트에서 실행 중입니다.');
});

3.2. 라우터 미들웨어 사용하기

const express = require('express');
const app = express();
const router = express.Router();

// 라우터 미들웨어
router.get('/user', (req, res) => {
    res.send('사용자 정보');
});

app.use('/api', router); // API 경로에 미들웨어 적용

app.listen(3000, () => {
    console.log('서버가 3000포트에서 실행 중입니다.');
});

3.3. 제3자 미들웨어 사용하기

제3자 미들웨어를 사용하려면 npm을 통해 해당 미들웨어를 설치하고, 사용할 수 있습니다.

npm install morgan

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

const app = express();

// morgan 미들웨어 등록
app.use(morgan('dev'));

app.get('/', (req, res) => {
    res.send('Morgan 로깅을 사용하는 서버');
});

app.listen(3000, () => {
    console.log('서버가 3000포트에서 실행 중입니다.');
});

4. 에러 핸들링 미들웨어

Express에서 에러 처리 또한 미들웨어를 통해 수행할 수 있습니다. 에러 핸들링 미들웨어는 일반 미들웨어와 다르게 네 개의 인수를 사용합니다: (err, req, res, next). 이 미들웨어는 애플리케이션의 마지막에 등록되어야 하며, 발생한 에러를 처리하는 역할을 합니다.

app.use((err, req, res, next) => {
    console.error(err.stack);
    res.status(500).send('서버에서 에러가 발생했습니다!');
});

5. 결론

Express에서 미들웨어는 애플리케이션의 핵심적인 요소로, 요청과 응답 처리, 코드 재사용성 및 유지보수성을 증대시키는 데 큰 역할을 합니다. 이번 강좌를 통해 미들웨어의 개념과 필요성을 이해하고, 기본적인 사용법을 익히는 데 도움이 되었기를 바랍니다. 미들웨어를 잘 활용하여 효율적이고 견고한 백엔드 서버 개발에 도전해 보시기 바랍니다.