Skip to content

[FEAT] 공통 응답, 예외 처리 구현#4

Merged
yongseong123 merged 1 commit into
mainfrom
feature/global-exception-handler
May 28, 2026
Merged

[FEAT] 공통 응답, 예외 처리 구현#4
yongseong123 merged 1 commit into
mainfrom
feature/global-exception-handler

Conversation

@yongseong123

Copy link
Copy Markdown
Collaborator

Pull Request

작업 개요

  • API 성공/실패 응답을 일관된 공통 포맷으로 반환하도록 구현했습니다.
  • 전역 예외 처리기를 추가해 검증 오류, 잘못된 요청, 리소스 없음, 미지원 메서드/미디어 타입, 서버 오류 응답을 표준화했습니다.

변경 사항

  • ApiResponse, ErrorResponse 공통 응답 DTO를 추가했습니다.
  • ErrorCode, BootSignalException, GlobalExceptionHandler를 추가했습니다.
  • ResponseBodyAdvice 기반 성공 응답 자동 래핑을 추가했습니다.
  • 응답 포맷과 예외 처리 MockMvc 테스트를 추가했습니다.
  • 한글 메시지 컴파일 안정성을 위해 JavaCompile UTF-8 인코딩을 설정했습니다.

관련 이슈

테스트

  • 로컬에서 기능 동작을 확인했습니다.
  • 빌드 또는 테스트가 통과했습니다.
  • 변경된 API의 성공, 실패 케이스를 확인했습니다.
  • 요청 값 검증과 예외 처리를 확인했습니다.

체크리스트

  • 불필요한 로그, 주석, 디버깅 코드를 제거했습니다.
  • API 명세 변경 사항을 문서화했거나 공유했습니다.
  • 인증, 인가, 입력 검증 영향을 확인했습니다.
  • DB 스키마, 마이그레이션, 초기 데이터 변경 여부를 확인했습니다.
  • 환경 변수나 배포 설정 변경이 있다면 문서화했습니다.

API 변경 사항

  • 추가 또는 변경된 엔드포인트: 전체 REST API 응답 포맷 공통 적용
  • 요청 예시: 기존 요청 형식 유지
  • 응답 예시:
{
  "success": true,
  "data": {},
  "error": null
}
  • 에러 응답:
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "요청 값이 올바르지 않습니다.",
    "fieldErrors": []
  }
}

리뷰 포인트

  • 공통 응답 필드명(success, data, error)과 에러 코드 체계가 프론트엔드 연동에 적합한지 확인 부탁드립니다.
  • ResponseBodyAdvice 적용 범위와 파일/스트리밍 응답 제외 조건이 이후 API 확장에 적절한지 확인 부탁드립니다.

@yongseong123 yongseong123 marked this pull request as ready for review May 27, 2026 12:53
@2mhh 2mhh self-requested a review May 28, 2026 08:40
@yongseong123 yongseong123 merged commit 9db3691 into main May 28, 2026
1 check passed
@yongseong123 yongseong123 self-assigned this Jun 15, 2026
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.

[FEAT] 공통 응답 포맷 및 전역 예외 처리 구현

3 participants