API 버전 관리, 어떻게 해야 할까? 개발자들의 다양한 의견을 살펴보자!
by DD
1개월 전
조회수 6
API 버전 관리 방식에 대한 다양한 접근 방식(Various Approaches)이 존재하며, URL 경로에 버전 정보를 포함하는 방식에 대한 비판적 시각도 존재함
SemVer(Semantic Versioning)를 API에 적용하는 방식과, /v1/, /v2/와 같은 경로 기반 버전 관리 방식의 장단점이 논의됨
Google의 API 설계 가이드라인(API Design Guidelines)과 Buttondown의 API 버전 관리 사례가 소개됨
속성 이름 변경과 같은 API 변경(API Changes)에 대한 대응 전략으로 속성 중복, 마이그레이션(Migration) 정의 등이 제시됨
URL 경로 기반 버전 관리 vs SemVer
논의에서는 URL 경로에 `/v1/`과 같은 버전 정보를 포함하는 방식이 SemVer와 충돌할 수 있다는 점을 지적한다. SemVer(Semantic Versioning)의 세부 버전(major.minor.patch)과 URL 경로의 `/v1/`이 중복되어 API 계약(API Contract)을 두 곳에서 관리해야 하는 문제가 발생할 수 있다는 것이다. API 계약(API Contract)의 분산은 유지보수(Maintenance) 및 배포(Deployment) 과정에서 혼란을 야기할 수 있다.
Google의 API 설계 가이드라인
Google의 API 설계 방식이 소개되었으며, AIP-185(API Versioning) 및 AIP-180(Backwards Compatibility)와 같은 가이드라인이 제시되었다. Google의 API 설계는 특정 환경에 맞춰져 있지만, API 설계 시 유용한 아이디어를 제공한다. 특히, 시 을 유지하는 방법에 대한 구체적인 지침을 제공하며, 이는 API 사용자에게 안정적인 서비스를 제공하는 데 중요한 요소로 작용한다.
