백엔드 개발 일지

마이크로서비스 아키텍처는 애플리케이션을 독립적인 서비스들로 나누어 각 서비스가 독립적으로 배포 및 확장 가능하도록 하는 접근 방식입니다. 이러한 환경에서 API 게이트웨이는 클라이언트와 여러 마이크로서비스 간의 상호작용을 관리하는 중요한 역할을 합니다. 본 글에서는 마이크로서비스 환경에서 API 게이트웨이를 설계할 때 고려해야 할 요소와 구현 방법을 살펴보겠습니다.

API 게이트웨이의 역할

API 게이트웨이는 다음과 같은 기능을 제공합니다:

라우팅: 클라이언트 요청을 적절한 마이크로서비스로 라우팅합니다.
인증 및 인가: 모든 요청에 대해 인증 및 인가 절차를 수행하여 보안을 강화합니다.
부하 분산: 요청을 여러 인스턴스에 분산시켜 서버의 부하를 조절합니다.
API 버전 관리: 다양한 버전의 API를 관리하여 클라이언트의 호환성을 유지합니다.
로깅 및 모니터링: API 호출에 대한 로깅 및 성능 모니터링을 통해 운영 상태를 파악합니다.

API 게이트웨이 설계 원칙

1. 단일 진입점 제공

API 게이트웨이는 클라이언트와 서버 간의 단일 진입점을 제공합니다. 이를 통해 클라이언트는 다양한 서비스를 호출하기 위해 여러 엔드포인트를 기억할 필요가 없습니다. 예를 들어, 다음과 같은 구조를 가질 수 있습니다:

/api/users
/api/products
/api/orders

이러한 URL 대신 클라이언트는 단일 엔드포인트인 /api에 요청을 보낼 수 있습니다.

2. 인증 및 인가 구현

API 게이트웨이는 모든 요청에 대해 인증을 수행해야 합니다. JWT(Json Web Token)와 같은 토큰 기반 인증 방식을 사용하면, 클라이언트는 로그인 후 받은 토큰을 사용해 API 요청을 할 수 있습니다. 아래는 Node.js와 Express를 이용한 간단한 인증 미들웨어 예제입니다:

const jwt = require('jsonwebtoken');

const authenticate = (req, res, next) => {
    const token = req.headers['authorization'];
    if (!token) return res.sendStatus(403);

    jwt.verify(token, process.env.JWT_SECRET, (err, user) => {
        if (err) return res.sendStatus(403);
        req.user = user;
        next();
    });
};

3. 로깅 및 모니터링 기능

API 게이트웨이에서 요청과 응답에 대한 로깅을 통해 문제를 빠르게 파악하고 대응할 수 있습니다. 다음은 요청과 응답을 로깅하는 미들웨어 예제입니다:

const logger = (req, res, next) => {
    console.log([${new Date().toISOString()}] ${req.method} ${req.url});
    res.on('finish', () => {
        console.log([${new Date().toISOString()}] ${res.statusCode});
    });
    next();
};

4. 응답 집계

다수의 마이크로서비스에서 데이터를 집계하여 클라이언트에게 반환할 때, API 게이트웨이는 이러한 집계를 처리할 수 있습니다. 예를 들어, 사용자 정보와 주문 정보를 함께 가져오는 API를 설계할 수 있습니다. 다음은 가상의 집계 함수 예제입니다:

const aggregateUserAndOrders = async (userId) => {
    const user = await getUser(userId);
    const orders = await getOrdersByUserId(userId);
    return { ...user, orders };
};

app.get('/api/user-orders/:id', async (req, res) => {
    const userId = req.params.id;
    const data = await aggregateUserAndOrders(userId);
    res.json(data);
});

마무리

API 게이트웨이는 마이크로서비스 아키텍처의 핵심 구성 요소로, 클라이언트와 다양한 서비스 간의 상호작용을 원활하게 만들어주는 중요한 역할을 합니다. 효율적인 라우팅, 인증, 로깅 및 집계 기능을 통해 서비스의 품질을 높이고 운영 효율성을 개선할 수 있습니다. 각 서비스가 독립적으로 작동하더라도 API 게이트웨이를 통해 unified한 서비스 경험을 제공할 수 있습니다. 따라서 API 게이트웨이를 설계할 때 위에서 언급한 원칙들을 잘 지키고 실용적으로 구현하는 것이 중요합니다.

마이크로서비스 환경에서의 API 게이트웨이 설계