API HATEOAS 적용 (자기 설명적, 클라이언트 의존성, 실무 적용)

REST API를 개발하면서도 HATEOAS(Hypermedia as the Engine of Application State)라는 원칙을 제대로 이해하지 못했습니다. 그냥 URI 구조만 신경 쓰면 REST라고 생각했거든요. 그런데 한 프로젝트에서 이걸 직접 적용해보려고 시도했을 때, 이게 생각보다 훨씬 복잡하고 실무에서는 논란이 많은 개념이라는 걸 깨달았습니다. HATEOAS는 API 응답에 다음 행동 가능한 링크를 포함해서 클라이언트가 문서 없이도 API를 탐색할 수 있게 하는 방식인데, 이게 정말 REST의 이상적인 구현일까요, 아니면 불필요한 복잡성을 추가하는 걸까요?

자기 설명적 API 구조의 이상과 현실

HATEOAS를 적용하면 API 응답이 자기 설명적(Self-Descriptive)이 됩니다. 쉽게 말해 서버가 보내는 응답 안에 "다음에 뭘 할 수 있는지" 정보가 모두 들어있다는 뜻입니다. 예를 들어 주문 정보를 조회했을 때, 응답에 "결제하기", "취소하기", "배송 조회" 같은 링크가 함께 포함되는 거죠. 이론적으로는 클라이언트 개발자가 API 문서를 일일이 찾아보지 않아도, 서버가 제공하는 링크만 따라가면 모든 기능을 사용할 수 있습니다.

이걸 구현해봤을 때 느낀 건, 설계 단계에서는 정말 멋진 아이디어처럼 보였다는 겁니다. 각 리소스마다 가능한 액션을 링크로 제공하니까 API 구조가 명확해 보였거든요. 그런데 막상 응답 구조를 짜다 보니 데이터보다 링크 정보가 더 많아지는 상황이 발생했습니다. 단순한 사용자 정보 조회 API에서도 관련 링크를 여러 개 포함하다 보니 JSON 응답이 복잡해졌고, 프론트엔드 팀에서는 이걸 파싱하는 로직이 오히려 번거롭다는 피드백을 주었습니다.

REST 아키텍처의 창시자인 로이 필딩(Roy Fielding)은 HATEOAS가 없으면 진정한 REST API가 아니라고 주장했습니다(출처: Roy Fielding's Blog). 하지만 상용 서비스를 보면 GitHub API, Twitter API 같은 유명한 REST API들도 HATEOAS를 완전히 적용하지 않는 경우가 많습니다. 이상적인 원칙과 현실적인 개발 효율성 사이에서 어떤 선택을 해야 할까요?

클라이언트 의존성 감소와 구현 복잡도의 딜레마

HATEOAS를 지지하는 분들은 클라이언트와 서버의 결합도(Coupling)를 낮출 수 있다고 강조합니다. 여기서 결합도란 두 시스템이 서로 얼마나 의존하는지를 나타내는 지표로, 결합도가 낮을수록 한쪽을 수정해도 다른 쪽에 영향을 덜 줍니다. 예를 들어 서버에서 API 경로를 변경해도 클라이언트는 서버가 제공하는 링크만 따라가면 되니까, 이론적으로는 클라이언트 코드를 수정하지 않아도 됩니다.

이건 정말 매력적인 장점처럼 들렸습니다. 초기 설계 회의에서 팀원들과 "나중에 API 버전 관리가 편해지겠다"며 기대했거든요. 하지만 구현하면서 몇 가지 문제가 드러났습니다. 먼저 프론트엔드에서 동적으로 링크를 해석하는 로직을 작성해야 했는데, 이게 생각보다 복잡했습니다. 특정 상황에서 어떤 링크가 나타날지 예측하기 어려웠고, 예외 처리도 까다로웠습니다.

또 HATEOAS를 제대로 활용하려면 클라이언트가 "링크 기반 네비게이션"을 지원해야 하는데, 일반적인 웹이나 앱 개발 방식과는 좀 다른 접근이 필요했습니다. 결국 저희 팀은 다음과 같이 절충안을 선택했습니다:

  1. 핵심 비즈니스 플로우(주문-결제-배송)에만 HATEOAS 적용
  2. 단순 조회 API는 기존 방식 유지
  3. 링크 정보는 선택적으로 포함(클라이언트가 필요할 때만 사용)

모든 API에 일괄 적용하는 건 비효율적이었습니다. 서비스 특성에 따라 선택적으로 도입하는 게 현실적인 접근이라고 생각합니다.

실무 적용에서의 한계와 선택적 도입 전략

대부분의 상용 API에서 HATEOAS를 완전히 적용하지 않는 데는 이유가 있습니다. 여러 프로젝트를 경험하면서 느낀 건, HATEOAS가 빛을 발하는 경우는 상당히 제한적이라는 겁니다. 특히 CRUD(Create, Read, Update, Delete) 중심의 단순한 API에서는 HATEOAS의 장점이 거의 체감되지 않았습니다. 사용자 목록을 가져오는 API에 굳이 다음 페이지 링크, 상세 조회 링크, 수정 링크를 모두 포함할 필요가 있을까요?

반면 복잡한 워크플로우를 가진 시스템에서는 유용할 수 있습니다. 제가 참여했던 프로젝트 중 전자결재 시스템이 있었는데, 문서의 상태(작성중, 결재중, 승인, 반려)에 따라 가능한 액션이 계속 바뀌었습니다. 이런 경우 서버가 현재 상태에서 가능한 액션 링크를 제공하면 클라이언트 로직이 훨씬 단순해졌습니다. 일반적으로 HATEOAS는 상태 기반 플로우가 복잡한 도메인에 적합하다고 알려져 있습니다.

실무에서 HATEOAS를 도입하려면 다음을 고려해야 합니다. 첫째, 팀의 개발 역량과 학습 비용입니다. HATEOAS는 개념 자체가 생소하기 때문에 팀원들이 이해하고 활용하는 데 시간이 걸립니다. 둘째, API 응답 크기 증가입니다. 링크 정보가 추가되면서 네트워크 트래픽이 늘어날 수 있습니다. 특히 모바일 환경에서는 부담이 될 수 있습니다. 셋째, 기존 시스템과의 호환성입니다. 이미 운영 중인 API에 HATEOAS를 추가하려면 클라이언트도 함께 수정해야 하는데, 이게 쉽지 않습니다.

개인적으로는 HATEOAS를 "선택적으로" 도입하는 게 가장 현실적이라고 봅니다. 모든 API에 일괄 적용하기보다는, 정말 필요한 부분(복잡한 워크플로우, 자주 변경되는 비즈니스 로직)에만 적용하는 거죠. REST의 이상적인 원칙을 따르되, 실무에서의 효율성도 함께 고려하는 균형 잡힌 접근이 필요합니다.

결국 HATEOAS는 "반드시 적용해야 하는 규칙"이 아니라 "상황에 따라 선택하는 도구"라고 생각합니다. 여러 번 시행착오를 겪으면서 내린 결론은, 이상적인 아키텍처 원칙보다 서비스 환경에서 팀이 효율적으로 개발하고 유지보수할 수 있는 구조가 더 중요하다는 것입니다. 만약 여러분 팀에서 HATEOAS 도입을 고민 중이라면, 먼저 작은 범위에서 시범 적용해보고 실제 효과를 측정해보시길 권합니다. 이론과 실무 사이의 간극을 직접 경험해보는 게 가장 확실한 판단 기준이 될 겁니다.

댓글

댓글 쓰기

이 블로그의 인기 게시물

HTTP 메서드의 필요성 (GET과 POST, PUT과 DELETE, API 보안)

API를 이해하는 과정에서 HTTP 메서드는 빠질 수 없는 핵심 개념입니다. GET, POST, PUT, DELETE 같은 용어는 처음 접하는 사람에게 다소 생소하게 느껴질 수 있지만, 사실 이들은 API가 명확하게 소통하기 위해 만든 매우 직관적인 약속입니다. 단순히 데이터를 주고받는 것을 넘어, 그 요청이 어떤 행동을 의미하는지 정확히 전달하기 위한 장치인 것입니다. 이 글에서는 HTTP 메서드가 왜 등장했으며, API 구조에서 어떤 역할을 하는지 비개발자의 관점에서 살펴보겠습니다. GET과 POST의 역할 구분과 실용성 HTTP 메서드 중에서도 GET과 POST는 가장 빈번하게 사용되는 메서드입니다. GET은 정보를 조회할 때 사용되며, POST는 새로운 데이터를 서버에 전달할 때 사용됩니다. 이 두 메서드의 구분은 단순해 보이지만, API 설계에서 매우 중요한 의미를 가집니다. 정보를 단순히 읽어오는 행위와 서버의 상태를 변경하는 행위는 본질적으로 다르기 때문입니다. 도서관에서 책을 읽는 행위를 생각해보면 이해가 쉽습니다. 책을 읽는다고 해서 도서관의 장서가 변하지는 않습니다. 하지만 새로운 책을 기증하거나 기존 책을 대출하면 도서관의 상태는 분명히 달라집니다. GET 메서드는 전자와 같이 서버에 아무런 변화를 주지 않고 정보만 가져오는 안전한 요청입니다. 반면 POST 메서드는 후자처럼 서버에 새로운 데이터를 추가하거나 상태를 변경하는 요청입니다. 이러한 구분은 API의 예측 가능성을 높입니다. 개발자는 GET 요청이 들어왔을 때 서버 상태가 변하지 않을 것이라는 확신을 가질 수 있고, POST 요청에 대해서는 적절한 검증과 보안 절차를 적용할 수 있습니다. 또한 GET 요청은 브라우저에 캐시될 수 있어 성능 최적화에도 유리합니다. 같은 정보를 반복해서 요청할 때 서버에 부담을 주지 않고 저장된 결과를 빠르게 제공할 수 있는 것입니다. 사용자 입장에서도 이 구분은 중요합니다. 웹페이지를 새로고침했을 때 결제가 중복으로 처리되지 않는 ...
자세한 내용 보기

API 없는 세상의 불편함 (로그인 연동, 서비스 구조, 디지털 인프라)

우리는 하루에도 수십 번씩 스마트폰 앱을 실행하고 웹 서비스를 이용합니다. 로그인 정보가 자동으로 불러와지고, 위치 기반 추천이 자연스럽게 제공되며, 결제 버튼을 누르는 순간 모든 과정이 매끄럽게 연결됩니다. 이런 당연한 편리함 뒤에는 API라는 보이지 않는 기술이 작동하고 있습니다. 만약 API가 존재하지 않는다면 지금의 디지털 환경은 과연 어떤 모습일까요. 이 글에서는 API가 사라진 세상을 가정하며, 우리가 일상적으로 사용하는 서비스들이 겪게 될 구체적인 불편함을 살펴봅니다. API 부재가 만드는 비효율적인 개발 환경과 로그인 연동의 중요성 API가 없는 세상에서는 각 서비스가 필요한 모든 기능을 처음부터 직접 구축해야 합니다. 날씨 정보를 제공하려면 기상 관측 장비부터 데이터 분석 시스템까지 자체적으로 갖춰야 하고, 지도 서비스를 운영하려면 전국의 도로 정보를 지속적으로 수집하고 갱신하는 인프라를 구축해야 합니다. 이는 마치 집에서 밥 한 끼를 먹기 위해 쌀농사부터 시작해야 하는 상황과 다르지 않습니다. 현실적으로 감당하기 어려운 비용과 시간이 소요될 수밖에 없습니다. 특히 로그인 기능을 생각해보면 API의 가치가 더욱 명확해집니다. 현재 많은 서비스들은 자체 회원가입 대신 구글이나 SNS 계정으로 간편하게 로그인할 수 있는 방식을 제공합니다. 사용자는 아이디와 비밀번호를 새로 만들 필요가 없고, 서비스 운영자 역시 개인정보 관리와 보안 부담을 크게 줄일 수 있습니다. 이 모든 편리함의 핵심이 바로 외부 서비스가 제공하는 인증 API입니다. 필요한 정보만 안전하게 전달받는 구조 덕분에 서비스는 본질적인 가치 제공에 집중할 수 있고, 사용자는 번거로운 절차 없이 빠르게 서비스를 이용할 수 있습니다. 만약 API가 없다면 모든 서비스는 독자적인 인증 시스템을 구축해야 하고, 사용자는 서비스마다 별도의 계정을 생성하고 관리해야 하는 불편함을 감수해야 합니다. 보안 사고에 대한 책임도 각 서비스가 전적으로 져야 하므로 중소 규모의 스타트업이나 개...
자세한 내용 보기

API 이해하기 (서비스 연결, 시스템 협력, 디지털 구조)

현대 디지털 서비스의 거의 모든 기능 뒤에는 API가 작동하고 있습니다. 날씨 앱의 실시간 정보, 지도 앱의 경로 계산, 온라인 쇼핑몰의 즉시 결제 모두 API 덕분에 가능합니다. 하지만 많은 사람들이 API를 개발자만 아는 어려운 기술로 여깁니다. 이 글에서는 전문 용어보다 일상적인 예시와 비유를 통해 API의 개념과 역할을 풀어내며, 왜 API가 현대 IT 서비스의 핵심이 되었는지, 우리가 사용하는 서비스와 어떻게 연결되어 있는지를 자연스럽게 이해할 수 있도록 안내합니다. 서비스 연결의 필요성과 API의 탄생 배경 인터넷 초창기에는 하나의 서비스가 모든 기능을 직접 처리하는 구조가 일반적이었습니다. 웹사이트 하나가 로그인, 데이터 저장, 화면 출력까지 모두 책임지는 방식이었습니다. 하지만 서비스가 점점 복잡해지고 사용자 수가 폭발적으로 늘어나면서 이런 구조는 한계에 부딪히게 됩니다. 마치 작은 동네 가게가 갑자기 대형 마트 규모의 손님을 감당해야 하는 상황과 비슷합니다. 이때 등장한 개념이 바로 역할 분담입니다. 각 기능을 전문적으로 처리하는 시스템을 따로 두고, 필요할 때마다 서로 요청하고 응답하는 방식이 필요해졌습니다. API는 바로 이 지점에서 탄생했습니다. 서로 다른 시스템이 대화를 나눌 수 있도록 만들어진 약속이자 창구인 셈입니다. 그래서 API를 이해할 때 가장 중요한 포인트는 '혼자 일하지 않는다'는 점입니다. 현대의 서비스는 수많은 시스템이 협력하며 돌아가고, API는 그 협력의 언어 역할을 합니다. 식당에 비유하면 손님은 주방에 직접 들어가 요리하지 않습니다. 대신 메뉴판을 보고 주문을 하고, 종업원은 그 주문을 주방에 전달합니다. 주방은 요리를 완성해 다시 종업원에게 넘기고, 종업원은 음식을 손님에게 가져다줍니다. 이때 손님과 주방이 직접 대화하지 않도록 중간에서 연결해 주는 역할이 바로 종업원이며, API도 정확히 이런 방식으로 작동합니다. 앱이나 웹사이트는 직접 다른 시스템의 내부를 건드리지 않고, API라...
자세한 내용 보기