API Response 기본 형태

Response Object

데이터가 한번의 결과 Set으로 오는 경우

API V2에서 Waiker Response 는 모두 아래와 같은 response 형식을 가집니다.

실제 사용되는 데이터는 data object 안에 들어가 있고, API 문서에서는 data 부분만 설명합니다.

필드	타입	Description	예시 값
code	String	응답코드	OK
status	Integer	http 상태 코드	200, 404 등
message	String	응답 메시지	SUCCESS, FAIL
timestamp	String	메시지 응답 시각	2024-09-11 06:36:58.373705 +00:00
data	Object	실제 정보	data object

Pagination Response Object

데이터가 리스트의 형태로 오는 경우

필드	타입	Description	예시 값
code	String	응답코드	OK
status	Integer	http 상태 코드	200, 404 등
message	String	응답 메시지	SUCCESS, FAIL
timestamp	String	메시지 응답 시각	2024-09-11 06:36:58.373705 +00:00
page	Integer	요청한 페이지	1
size	Integer	요청한 결과 갯수	10
totalPage	Integer	전체 페이지	10
totalCount	Integer	전체 결과수	1000
data	Object	실제 정보	data object