API 버전 관리 방법
API 버전 관리 방법
- URI를 통한 버전 관리
- Header를 통한 버전 관리
- Request params를 통한 버전 관리
- Mime Type을 통한 버전관리
URI를 통한 버전 관리
API URI에 버전을 명시하는 방법
가장 흔하게 쓰이며 하위 호환성도 챙기기 쉬운 방법이다
https://2mukee.com/api/v1/notice
- 장점
클라이언트가 쉽게 리소스를 캐시 할 수 있다
- 단점
코드 베이스에 매우 큰 공간이 필요해짐
Header를 통한 버전 관리
HTTP Accept header 등 HTTP 헤더를 사용하여 버전을 명시
보편적으로 사용하는 헤더 혹은 커스텀 헤더를 사용
Accept: application/json; v=1 // MIME type versioning
X-API-VERSION=1
- 장점
간편하다
- 단점
매 요청마다 custom header가 필요하다
Request Params를 통한 버전 관리
https://2mukee.com/api/notice?version=2.0
- 장점
간편하다
- 단점
쿼리 매개변수가 항상 필요하며, 라우팅이 어려워진다
Reference
API 버전을 관리하는 방법?
개요 초기 서비스를 개발하고, 운영을 하다 보면 적지 않게 여러 요구사항과 이슈수정 그리고 업데이트에 의해 API의 버전들이 자주 변경됨을 알 수 있다. 제일 간편한방법은 각 API에 버전을 prefi
joecp17.tistory.com
[Spring] REST API Version 관리
Versioning 버전관리라는 것은 단순하게 사용자에게 보여주는 항목을 관리하는 것이 아닌 REST API 설계가 변경되거나 또는 Application의 구조가 변경되었을 시에도 버전을 변경해야 할수도 있다. 또한
sonseungha.tistory.com
‘API Versioning’은 반드시 필요할까? | 요즘IT
백엔드 개발자라면 동료 개발자나 외부 고객을 위해 API를 만들고 배포한 경험이 있을 것입니다. 이러한 API는 한번 만들고 배포하면, 삭제하거나 변경하는 게 어려워 집니다. 그래서 ‘API Versionin
yozm.wishket.com