DataGSM OAuth SDK 버저닝 컨벤션

개요

DataGSM OAuth SDK는 시맨틱 버저닝(Semantic Versioning) 을 기반으로 한 X.Y.Z 형식의 버전 체계를 사용합니다.

각 숫자는 변경의 성격과 하위 호환성 여부를 나타내며, 이를 통해 SDK를 사용하는 개발자가 업데이트 시 예상되는 영향을 명확하게 파악할 수 있습니다.

버전 구성

Major (X)

아키텍처 변경 또는 주요 기능에 대한 큰 변경이 있을 때 올립니다.

Major 버전이 올라가면 하위 호환성을 보장하지 않습니다. 기존 코드가 동작하지 않을 수 있으므로, Major 버전 업데이트 시에는 마이그레이션 가이드를 반드시 확인하세요.

Major 버전이 올라가는 경우:

• SDK 전반의 아키텍처 구조 변경
• 기존 공개 API의 삭제 또는 시그니처 변경
• 의존성 라이브러리의 주요 버전 업그레이드로 인한 호환성 변경

Minor (Y)

기능 추가 또는 변경 등으로 API Spec이 변경될 때 올립니다.

Minor 버전이 올라가면 하위 호환성을 보장하지 않습니다. 새로운 API가 추가되거나 기존 API의 동작 방식이 변경될 수 있습니다.

Minor 버전이 올라가는 경우:

• 새로운 OAuth 엔드포인트 또는 기능 지원 추가
• 요청·응답 모델의 필드 추가 또는 변경
• 기존 인증 플로우의 동작 방식 변경

Patch (Z)

단순 버그 수정, 리팩터링, 성능 개선 등 API Spec에 대한 변경이 없을 때 올립니다.

Patch 버전이 올라가면 하위 호환성을 보장합니다. 기존 코드를 수정하지 않아도 동작합니다.

Patch 버전이 올라가는 경우:

• 버그 수정
• 내부 코드 리팩터링
• 성능 개선
• 문서 또는 주석 수정

버전 예시