api versioning

API 버전 관리

버전은 URL 모양만 바꾸는 기능이 아니라 기존 클라이언트를 언제까지 지킬지 정하는 운영 계약입니다.

uri

URI 버전

경로에 v1, v2를 드러내 문서와 테스트를 분리하기 쉽습니다.

header

헤더 버전

URL은 유지하지만 클라이언트가 명시적으로 버전을 보내야 합니다.

계약

계약 분리

DTO, 응답 필드, 오류 형식을 버전별로 비교해 깨지는 변경을 표시합니다.

sunset

종료 정책

구버전 지원 종료일과 마이그레이션 안내가 없으면 버전이 계속 쌓입니다.

변경 전 필드 추가인지 의미 변경인지, 기존 클라이언트가 깨지는지 먼저 분류합니다.
배포 중 새 버전 라우트와 Swagger 문서를 나눠 테스트 케이스를 동시에 유지합니다.
운영 후 사용량 로그를 보고 구버전 제거 시점과 공지 범위를 결정합니다.