API Version

API 버전 관리 방식 비교

버전 관리는 기존 클라이언트를 깨지 않으면서 새 계약을 도입하는 방법이다. URI, Header, Media Type 방식이 다르게 드러난다.

요청이 버전을 선택하는 방식

compatibility

URI 버전

/v1/users처럼 경로에 버전을 넣어 가장 눈에 잘 보인다.

헤더 버전

URL은 유지하고 커스텀 헤더로 계약을 선택한다.

Media Type

Accept 헤더의 타입으로 표현 방식을 구분한다.

마이그레이션

구버전 유지 기간과 제거 공지를 함께 설계한다.

clientversion signalcontroller계약response
버전 운영 해석

버전 방식은 기술보다 운영 약속이다. 누가 어떤 버전을 얼마나 오래 쓰는지까지 정해야 전략이 완성된다.