API Versioning 관련

[hepheir]

9adfad9 (main) 커밋 시점 이후로 가장 최신 변경사항 9ff5a94 에서 엔드포인트에 많은 변경 사항이 있었는데 OpenAPI Spec 상 표기된 버전은 0.0.1로 동일한 것으로 확인됩니다.

추후 혼란을 방지하고자 0.1.0 혹은 그 외 방식으로든 버저닝을 하면 어떨까 제안합니다.

[hepheir]

0.0.1 → 0.0.2 4178d54

[hepheir]

0.0.2 → 0.0.3 9745427

• Racemap 용 최고/최근 기록 api 추가 (추후 제거/수정 예정)

[nicehcy2]

Semantic Versioning (SemVer)

MAJOR . MINOR . PATCH
  1   .   2   .   3

번호	언제 올리나	예시
MAJOR	Breaking Change (하위 호환 깨짐)	1.0.0 → 2.0.0
MINOR	기능 추가 (하위 호환 유지)	1.0.0 → 1.1.0
PATCH	버그 수정	1.0.0 → 1.0.1

위와 같은 양식으로 버전을 관리하겠습니다.

[nicehcy2]

@hepheir

클라이언트 로직이 무조건 변경되는 경우에 /api/v2 같은 방식으로 URI path를 올릴까요,
아니면 서버 구조가 크게 바뀌는 경우에만 올릴까요?

[hepheir]

@nicehcy2 님 말씀대로 클라이언트 로직이 변경되는 경우 올리는 것도 분명 좋은 방법일 수 있으나,
기본 기조로는 url path인 /api/v#/ 에 표기되는 버전 번호는 major 버저닝을 따라가면 좋을 것 같다는 의견입니다.

다만 아직은 semver 기준 0.x.x번대 즉, 개발 버전이므로 api url path는 당장 신경쓰지 않아도 될 것 같습니다.