REST API Custom Response Body

{
	"resultCode": 0,
	"message": "OK",
	"data": {
    
	}
}

• resultCode: 처리 결과 상태 코드
• message: 개발자가 위키를 보지 않아도 알 수 있는 메세지 값, 개발자를 위한 메세지
• data: API가 전달해야하는 리소스 내용 혹은 처리 결과 값

Synnote resultCode - message

개요

HTTP Status Code로 요청에 대한 처리의 상태를 알 수 있지만, 서비스가 구체화되면서 다양한 에러 케이스들을 상세히 분류하고 서비스 자체의 상태 코드와 리스폰스 형식을 만들어야 할 필요성을 느낌

형식

resultCode

성공에 대한 상태 코드는 C_00, 정의되지 않은 에러의 상태 코드는 C_99을 줌 (C는 Common이라는 뜻)

예상 가능한 에러들에 대해 상태 코드를 붙여준다면 단순한 404, 400 같은 HTTP Status Code를 넘겨줄 때보다 명시적인 소통이 가능함

또한 추후 서버 간 통신이 필요할 경우에도 어떤 서버에서 문제가 생겼는지 추적이 가능함

message

개발자가 resultCode에 대한 위키를 찾아보지 않아도 알 수 있도록 response에 대한 정보를 제공하는 메세지