Skip to content

Conversation

@ohksj77
Copy link
Member

@ohksj77 ohksj77 commented Jan 1, 2026

수정 이유

추가/수정한 기능

공통 응답 & 에러 규격

  • 공통 응답 규격 추가: ApiResponse, 에러 규격 추가: ErrorDetail
    • 이 둘을 생성하기 위한 팩토리 메서드 추가
  • 비즈니스 최상위 예외 추가, 에러 코드 명세를 위한 enum 추가
  • 전역 에러 핸들링 Advice 추가
  • 응답 Body Advice 추가 (ApiResponse 래핑을 위함)

Etc

  • Url Path 기반 버저닝에서 헤더 기반 버저닝으로 이전 (Swagger 충돌 이슈로 인함)
  • 인프라 설정의 헬스 체크 Url 내의 버전 path 제거

특이사항

  • 아래는 API 규격 예시입니다:

  • 성공

image
  • 실패
image

check list

  • 모든 단위 테스트를 돌려보고 기존에 작동하던 테스트에 영향이 없는 것을 확인했나요?
  • 추가/수정사항을 설명했나요?

추가사항으로 api 버저닝 방식 수정으로 인프라 일부가 수정되었으며 validation 의존성을 추가했습니다.
Swagger와의 충돌 해결을 위하여 이전했습니다.
@ohksj77 ohksj77 requested a review from JihwanByun January 1, 2026 12:31
@ohksj77 ohksj77 self-assigned this Jan 1, 2026
@ohksj77 ohksj77 added the feature New feature or request label Jan 1, 2026
@ohksj77 ohksj77 linked an issue Jan 1, 2026 that may be closed by this pull request
@ohksj77 ohksj77 added setting Project setting and removed feature New feature or request labels Jan 1, 2026
@JihwanByun
Copy link
Contributor

Url Path 기반 버저닝에서 헤더 기반 버저닝으로 이전 (Swagger 충돌 이슈로 인함)
이부분 더 자세히 설명해주실 수 있을까요?

@ohksj77 ohksj77 changed the base branch from main to develop January 3, 2026 08:04
@ohksj77
Copy link
Member Author

ohksj77 commented Jan 3, 2026

Url Path 기반 버저닝에서 헤더 기반 버저닝으로 이전 (Swagger 충돌 이슈로 인함)
이부분 더 자세히 설명해주실 수 있을까요?

swagger가 자동으로 만들어주는 url 중에 /v3/api-docs 라는 path 가 있는데, 저희가 기존에 활용하고자 했던 api/v1 과 충돌이 발생하여 swagger가 접근이 안되는 이슈가 발생했었습니다. 이에 헤더에 버전을 넣도록 수정하였습니다.

@ohksj77 ohksj77 merged commit b867255 into develop Jan 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

setting Project setting

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[SETTING] API 공통 규격 설정

3 participants