CTRL-F Back-end Default API Spec

Format

기본 응답 포맷

// SUCCESS
{
 ...
}
 
// FAIL/ERROR
{
 "message": "", // 사용자 노출 에러 메세지,
}

예시

SUCCESS(2XX)

// Single
{
 "id": 1,
 "title": "테스트 타이틀 입니다",
 "contents": "테스트 컨텐츠 입니다."
}
// Multiple
{
 "pagination": {
 "has_next": true,
 "total_count": 1,
 "page": 1,
 "page_size": 200
 },
 "results": [
 {
 "id": 1,
 "title": "테스트 타이틀 입니다.",
 "contents": "테스트 컨텐츠 입니다."
 },
 {...},
 {...},
 {...}
 ...
 ]
}

FAIL(4XX)

// Single
{
 "message": "ID,PW 값이 유효하지 않습니다.
}
// Multiple - 복수의 에러에 대한 정보가 필요할 시에는 수정 필요
{
 "message": "ID,PW 값이 유효하지 않습니다. 
}

Error(5XX)

// Expected - 에러에 대한 상세 정보가 필요할 시에는 수정 필요
{
 "message": "서버 에러가 발생 하였습니다."
}
// UnExpected

Status Code

Methods

Headers