프로젝트/파이널 프로젝트

Request Parameter와 Header를 이용한 API Version 관리

Kiwisae 2022. 11. 24. 18:20

Request Parameter를 이용한 방법으로,

params에 담긴 버전 정보가 추가로 전달된다.

params 값을 전달해야 하므로 ? 를 추가해서

 

 

 

 

 

 

 

header 값을 위한 버전 관리를 실습해 보기 위해

value와 params 에 값을 담았던 것은 주석 처리로 막아버리고 새로운 어노테이션을 추가했다.

 

 

 

 

버전별로 다른 데이터를 정확히 가져온다.

 

 

 

 

 

버전 관리는 단순히 사용자에게 보여지는 데이터를 제한하는 용도 뿐 아니라

REST API의 설계가 변경되거나 구조가 변경될 때도 사용한다.

사용자에게도 어떤 API 버전을 사용해야 할지 적절한 가이드를 제시한다.

 

 

URI 값은 간단 명료하게

잘못된 헤더 값에 주의

웹 브라우저를 사용하며 남은 캐시로 지정된 값이 반영되지 않는 경우 주의 (캐시 삭제)

별도의 크롤링 작업이 없어도 웹 브라우저에서 실행 가능하면 좋음

개발을 도울 적절한 문서