API 명세 | Notion

공통 응답 구조

CommonApiResponse<T>

모든 API 응답은 CommonApiResponse<T> 구조를 따릅니다.

위치: src/main/java/com/rebra/common/CommonApiResponse.java

응답 필드

필드	타입	필수	설명
`success`	`boolean`	O	요청 성공 여부 (`true`: 성공, `false`: 실패)
`status`	`int`	O	HTTP 상태 코드 (200, 400, 401, 404, 500 등)
`data`	`T`	X	응답 데이터 (성공 시에만 포함)
`errorCode`	`string`	X	에러 코드 (실패 시에만 포함)
`errorMessage`	`string`	X	에러 메시지 (실패 시에만 포함)
`errorData`	`object`	X	추가 에러 정보 (필요 시에만 포함)
`timestamp`	`string`	O	응답 생성 시각 (ISO 8601 형식)

응답 원칙

@JsonInclude(NON_NULL): null 값인 필드는 응답 JSON에서 제외됨
성공 응답: success=true, data 포함, 에러 필드 제외
실패 응답: success=false, 에러 필드 포함, data 제외

성공 응답

1. 데이터가 있는 성공 응답

사용 예시: 단건 조회, 생성, 수정 등

응답 예시:

{
  "success": true,
  "status": 200,
  "data": {
    "userId": 1,
    "nickname": "투자왕",
    "phoneNumber": "010-1234-5678"
  },
  "timestamp": "2025-10-16T14:30:00"
}

2. 데이터가 없는 성공 응답

사용 예시: 삭제, 로그아웃 등

응답 예시:

{
  "success": true,
  "status": 200,
  "timestamp": "2025-10-16T14:30:00"
}