AWS 에 구축하는 클라우드 디자인 패턴 시리즈 4부: API 관리

클라우드 컴퓨팅, 마이크로서비스 아키텍처, 빅데이터, 인공지능과 같은 기술의 발전과 함께 우리의 시스템은 더 유연하게 확장하고 상호작용할 수 있도록 진화하였고, 이에 따라 API 관리도 이전보다 더 복잡하고 동적인 과제로 변모하고 있습니다. 기업은 안정적이고 확장 가능한 API를 설계하고 애플리케이션과 서비스 간의 원활한 통신을 위한 방법을 모색하고 있으며, 이때 필수적으로 고려되는 주제 중 하나가 바로 API (Application Programming Interface) 라우팅 패턴입니다.

API 라우팅 패턴은 API를 관리하고 클라이언트 요청을 적절한 서비스 또는 엔드포인트로 라우팅하는 방식을 말합니다. 이는 소프트웨어 시스템에서 서로 다른 마이크로서비스나 엔드포인트 간의 효율적이고 유연한 통신을 지원하기 위한 전략이며 다양한 패턴이 존재합니다.

이 블로그 글에서는 다양한 API 라우팅 패턴을 살펴보고 각 패턴의 특징과 장단점, 선택 요령, 구현 방법에 대해 탐구해 볼 것입니다. 이러한 패턴들은 현대 시스템에서 데이터의 효과적인 전달과 관리를 가능케 하며, 안정성과 일관성을 유지하는 데 중요한 역할을 합니다. 이러한 패턴과 접근 방식을 이해하고 적용한다면 API 관리에 대한 통찰력을 확장할 수 있고 기업은 혁신을 이루는 데 도움이 되리라 믿습니다. 이제 API 라우팅 패턴에 대해 자세히 알아보겠습니다.

API 라우팅 패턴

API 라우팅은 클라이언트가 요청한 API 엔드포인트를 해당 요청을 처리할 수 있는 적절한 서비스 또는 기능으로 연결하는 방법입니다. 이 패턴은 대규모 애플리케이션에서 API 관리를 용이하게 하고, 복잡한 구조에서도 효율적으로 작동할 수 있도록 도와줍니다.

API 라우팅 패턴은 애자일한 개발 환경에서 여러 팀이 각자의 마이크로서비스를 개발하고, 이를 API로 노출하여 상호 작용할 수 있도록 하는 중요한 전략입니다. 이 패턴은 다양한 방법을 사용하여 서비스를 클라이언트에 노출함으로써 서비스 간 통신을 관리합니다.

호스트 이름과 경로를 사용하여 업스트림 소비자에게 HTTP API를 노출하는 세 가지 주요 방법이 있습니다.

호스트 이름 라우팅
경로 라우팅
헤더 기반 라우팅

아래 섹션에서는 요구 사항 및 조직 구조에 가장 적합한 방법을 결정하는 데 도움이 되도록 이러한 세 가지 라우팅 방법의 일반적인 사용 사례와 장단점을 간략하게 설명합니다.

(1) 호스트 이름 라우팅

호스트 이름별 라우팅은 각 API에 고유한 호스트 이름을 부여하여 API 서비스를 분리하는 방법으로, service-a.api.example.com 또는 service-a.example.com과 같이 각각의 API 서비스를 식별합니다.

일반적인 사용 사례

다중 도메인 또는 서브도메인 지원 : 회사나 서비스에서 여러 브랜드, 제품 또는 서비스를 운영하는 경우에 사용됩니다. 각각의 브랜드나 서비스마다 고유한 도메인 또는 서브도메인을 할당하여, 해당 도메인에 따라 다른 API나 서비스로 라우팅할 수 있습니다.
환경 구분 (예: 개발, 테스트, 운영) : 개발, 테스트, 운영 환경 등 서로 다른 용도를 가진 여러 환경을 구분하기 위해 사용됩니다. 개발자들은 각각의 도메인 또는 서브도메인을 사용하여 서로 다른 API 버전이나 서비스에 접근할 수 있습니다.
다중 언어 또는 지역 지원 : 다국어 또는 다양한 지역에 대한 지원을 위해 사용됩니다. 서로 다른 지역 또는 언어에 대한 요청을 받아 해당 도메인에 따라 다른 콘텐츠 또는 서비스를 제공할 수 있습니다.
서비스 분리 : 마이크로서비스 아키텍처에서 여러 개별적인 마이크로서비스를 운영할 때, 각 서비스를 고유한 도메인 또는 서브도메인으로 분리하여 라우팅할 수 있습니다.
파티셔닝 및 테넌트 구분 : 다중 테넌시 애플리케이션에서 테넌트(사용자 또는 그룹)를 분리하기 위해 사용됩니다. 각 테넌트에 대한 요청을 해당 도메인으로 라우팅하여 서로 다른 데이터 또는 서비스를 제공할 수 있습니다.

이러한 사용 사례에서 호스트 이름 라우팅은 서로 다른 도메인 또는 서브도메인에 따라 API 엔드포인트를 분리하고, 각각에 맞는 서비스를 제공하는 데 효과적으로 활용됩니다.

호스트 이름별 라우팅은 서비스 팀 간에 아무것도 공유되지 않기 때문에 릴리스의 마찰을 줄일 수 있습니다. 대신 각 팀은 DNS 항목부터 프로덕션 환경의 서비스 운영에 이르기까지 모든 것을 관리하는 책임을 가집니다.

하이레벨 아키텍처

장점

확장이 쉽고 유연함 : 다중도메인이나 서비스 분리 시 HTTP API 라우팅을 위한 확장 가능한 간단한 방법.
AWS에서 쉽게 구현 : AWS와 같은 서비스를 활용한 아키텍처를 구축하는 데 유용.
분리된 서비스 제공 : 팀은 호스트 이름 라우팅을 통해 하위 도메인을 소유하고, 배포 시에 격리, 테스트, 오케스트레이션 하기 쉬워지고 릴리스 시 발생하는 마찰을 줄일 수 있습니다. (예: 특정 리전이나 버전으로 서비스를 구분할 수 있습니다. region.service-a.api.example.com 또는 dev.region.service-a.api.example.com).

단점

구성 복잡성 : 다수의 도메인 라우팅을 관리할 때 구성이 복잡해질 수 있습니다. 서버 설정이나 관리가 필요할 수 있습니다.
관리 및 유지보수의 어려움 : 수 많은 호스트나 도메인을 처리할 때 오작동의 가능성이 있습니다. 소비자가 각 API와 상호 작용하기 위해 서로 다른 호스트 이름을 기억해야 하고, 롤링 업데이트, 다국어, 버전 관리, 보안 문제, 버그 수정으로 인한 주요 변경 사항 전달, 문서 등을 지원해야 합니다.
보안 측면 : 호스트 이름 라우팅은 보안 측면에서 주의가 필요합니다. 올바른 권한과 접근 제어를 통해 안전성을 유지해야 합니다.

요약하면, 호스트 이름별 라우팅은 각 API를 독립적으로 운영하고 관리할 수 있으며, 각각의 서비스를 구분하기 쉽게 만들어줍니다. 그러나 이는 클라이언트 측에서 여러 호스트 이름을 관리해야 하므로 사용성을 고민해야 할 수 있을 수 있습니다.

호스트 이름 라우팅은 다양한 도메인 또는 서브도메인을 처리해야 하는 상황에서 유용하며, 특히 다중 서비스를 운영하고자 할 때 유연성을 제공합니다. 하지만 이는 관리 및 보안에 대한 주의가 필요한 기법이기도 합니다.

AWS 기반의 구현

Elastic Load Balancer를 사용하여 구현

팀은 Hostname 라우팅을 사용하여 하위 도메인을 완전히 소유할 수 있습니다.

Amazon API Gateway를 사용하여 구현

특정 배포를 더 쉽게 격리, 테스트 및 오케스트레이션 할 수 있습니다. (AWS 리전 또는 버전별 배포, 예를 들면 region.service-a.api.example.com 또는 dev.region.service-a.api.example.com)

(2) 경로 기반 라우팅

경로 기반 라우팅은 API 엔드포인트를 관리하고 요청을 처리하기 위한 가장 간단하고 직관적인 방법 중 하나이며, 여러 API 또는 모든 API를 동일한 호스트 이름으로 그룹화하고 요청 URI를 사용하여 서비스를 분리하는 메커니즘입니다. (예를 들면, api.example.com/service-a 또는 api.example.com/service-b)