URI
- 위치
- /v1/users
- 장점
- 브라우저와 문서에서 가장 명확하다.
- 주의
- 버전별 URI가 늘어난다.
버전 정보는 URL, 헤더, 미디어 타입 중 한 곳에 싣는다
선택 기준은 클라이언트에게 얼마나 잘 보이는지, 운영에서 얼마나 통제하기 쉬운지이다.
| 방식 | 버전 위치 | 장점 | 주의 |
|---|---|---|---|
| URI | /v1/users | 브라우저와 문서에서 가장 명확하다. | 버전별 URI가 늘어난다. |
| Header | X-API-Version: 1 | 리소스 URI를 깔끔하게 유지한다. | 클라이언트 헤더 설정을 확인해야 한다. |
| Media Type | Accept: application/json;v=1 | 응답 표현과 버전을 함께 협상한다. | 테스트와 학습 비용이 더 크다. |
Header
- 위치
- X-API-Version: 1
- 장점
- 리소스 URI를 깔끔하게 유지한다.
- 주의
- 클라이언트 헤더 설정을 확인해야 한다.
Media Type
- 위치
- Accept: application/json;v=1
- 장점
- 응답 표현과 버전을 함께 협상한다.
- 주의
- 테스트와 학습 비용이 더 크다.