Skip to content

[FEAT] Health Check API 구현#9

Merged
yongseong123 merged 1 commit into
mainfrom
feature/health-check-api
Jun 1, 2026
Merged

[FEAT] Health Check API 구현#9
yongseong123 merged 1 commit into
mainfrom
feature/health-check-api

Conversation

@yongseong123
Copy link
Copy Markdown
Collaborator

Pull Request

작업 개요

  • 서버 상태를 확인할 수 있는 Health Check API를 구현했습니다.
  • 배포, 모니터링, 클라이언트 연동 환경에서 백엔드 애플리케이션의 기본 실행 상태를 확인할 수 있도록 합니다.

변경 사항

  • GET /api/health 엔드포인트를 추가했습니다.
  • Health Check 응답 DTO를 추가했습니다.
  • 향후 인증 정책 변경 시에도 Health Check API가 공개 호출 가능하도록 SecurityConfig에 명시했습니다.

관련 이슈

테스트

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

체크리스트

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

API 변경 사항

  • 추가 또는 변경된 엔드포인트: GET /api/health
  • 요청 예시:
GET /api/health
  • 응답 예시:
{
  "success": true,
  "data": {
    "status": "UP",
    "message": "BootSignal API is running."
  },
  "error": null
}
  • 에러 응답: 별도 요청 값이 없는 상태 확인 API이며, 서버 내부 오류 발생 시 프로젝트 공통 에러 응답을 따릅니다.

리뷰 포인트

  • Health Check API 경로가 /api/health로 적절한지 확인 부탁드립니다.
  • 공통 응답 포맷과 공개 접근 설정이 프로젝트 정책에 맞는지 확인 부탁드립니다.

@yongseong123 yongseong123 marked this pull request as ready for review June 1, 2026 03:18
@yongseong123 yongseong123 merged commit c0a25f4 into main Jun 1, 2026
1 check passed
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] Health Check API 구현

2 participants