Skip to content

docs : API 버전 호환성 관리 문서 추가 - #8

Open
hoooonshub wants to merge 1 commit into
mainfrom
codex/api-versioning
Open

docs : API 버전 호환성 관리 문서 추가#8
hoooonshub wants to merge 1 commit into
mainfrom
codex/api-versioning

Conversation

@hoooonshub

Copy link
Copy Markdown
Collaborator

변경 내용

  • 운영 환경의 백엔드와 프론트엔드 버전 호환 범위를 관리하는 API versioning.md 문서를 추가했습니다.
  • 현재 호환 범위를 백엔드 1.0.x, 프론트엔드 1.0.x로 기록했습니다.
  • x, ^, 부등호, || 버전 범위 표기 규칙과 문서 갱신 원칙을 명시했습니다.

변경 이유

프론트엔드와 백엔드가 배포 전에 서로 호환되는 버전인지 공통 문서에서 바로 확인할 수 있도록 하기 위함입니다.

영향

실행 코드나 API 동작에는 영향이 없으며, 개발진이 운영 배포 버전의 호환성을 확인하고 직접 갱신하는 기준 문서가 추가됩니다.

검증

  • git diff --check origin/main...HEAD
  • origin/main 대비 변경 파일이 API versioning.md 1개인지 확인
  • 문서 및 PR 본문에 민감정보가 없는지 확인

@hoooonshub
hoooonshub marked this pull request as ready for review August 18, 2026 05:23
@pbk95120
pbk95120 self-requested a review August 25, 2026 12:37

@pbk95120 pbk95120 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

시멘틱 버저닝을 명시하면 어떨까

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants