버전 관리

1. URI를 통한 버전 관리

주소에 직접 버전 정보를 입력하여 버전을 관리하는 방식

http://localhost:8088/admin/v1/users/1와 같이 주소에 v1이 추가되는 방식으로 버전을 관리한다.

2. Parameter를 통한 버전 관리

Parameter를 사용하여 버전을 관리하는 방식

http://localhost:8088/admin/users/1?version=1와 같이 parameter인 version이 추가되는 방식으로 버전을 관리한다.

3. Headers를 통한 버전 관리

headers 값을 추가하여 버전을 관리하는 방식

headers에 X-API-VERSION 키를 추가하여 그 값에 따라 버전을 관리한다.

4. MIME-Type를 통한 버전 관리

특정한 데이터가 어떤 형식인지 알려주는 MIME-Type을 통해 버전을 관리하는 방식 위 사진과 같이 produces에 입력했던 형식대로 Accept에 적용하면 해당 버전이 나오는 방식이다.

버전 관리를 위한 중요한 점

1. URI를 너무 지저분하게 사용하지 않기(너무 과도한 정보 표기X)
2. 잘못된 Headers 값 사용에 주의하기
3. 인터넷의 캐싱으로 인해 우리가 변경한 값이 전달되지 않을 수 있다는 점 주의
   (적절하게 캐시를 삭제하여 변경 값이 전달되도록 하기)
4. 적절한 용도에 따라 웹 브라우저에서도 실행이 되도록 하기(GET 메소드 등의 경우)
5. API 가이드 문서를 제공하기(사용자들은 개발한 API 인터페이스를 알지 못하기 때문)