기본 정보

시작하기

이 문서는 Vacation Manager 에 대한 전반적 이해를 돕는 것을 목적으로 합니다.

규칙

모든 API 요청을 전송하는 기본 URI는 /api/v1입니다.

Vacation Manager 는 페이지와 데이터베이스 리소스에 대한 GET, POST, PATCH, DELETE 요청을 통해 작업을 수행하는 등 가능한 한 RESTful 규칙을 따릅니다.

요청과 응답 본문은 JSON으로 인코딩됩니다.

공통 응답 포맷 (Response Envelope)

모든 응답은 다음 형식으로 반환

{
  "code": 200,
  "errorCode": null,           // 오류가 없을 땐 null, 있으면 문자열 코드
  "message": "성공 메시지 또는 오류 메시지",
  "data": {
    // 리소스별로 다름 (예: 사용자, 그룹, 휴가 등)
  }
}
필드명 타입 설명
code number HTTP 상태 코드와 동일
errorCode string or null 애플리케이션 내부 오류 코드 (오류 없으면 null)
message string 응답 메시지
data object or array or null 실제 리소스 데이터 또는 null

data 필드 내부 JSON 규칙

규칙 항목 설명
속성 이름 모두 카멜 케이스(camelCase) 사용
시간 정보 서버 내부에서는 LocalDate, LocalDateTime 등의 객체로 처리하며, API 요청/응답에서는 ISO 8601 형식의 문자열 (예: "2025-06-28T14:00:00+09:00")로 교환합니다.
빈 문자열 빈 문자열 대신 null 사용
배열 응답 다건 응답 시 data는 배열 형태가 될 수 있음

상태 코드

HTTP 응답 코드는 일반적인 성공과 오류 클래스를 나타내는 데 사용됩니다.

✅ 성공 코드