콘텐츠로 이동

공통 응답 구조


필드 유형 설명
code Number 응답의 상태 코드입니다. 다음 예시는 표준 JSON 응답이며, 다운로드 등의 API는 각 페이지의 설명을 기준으로 합니다.
content String, Number, Array, Boolean, JSON 반환되는 데이터로, 구체적인 데이터 유형은 실제 API의 비즈니스 로직에 따라 달라집니다.
pageInfo JSON API가 페이지네이션을 제공할 때 반환되며, 구체적인 계층 구조는 각 API 설명을 기준으로 합니다.
pageInfo.count Number 현재 페이지 데이터 수
pageInfo.pageIndex Number 페이지 번호
pageInfo.pageSize Number 페이지 크기
pageInfo.totalCount Number 조건에 부합하는 전체 데이터 수
errorCode String 반환된 오류 상태 코드이며, 비어 있으면 오류가 없음을 의미합니다.
message String 반환된 오류 코드에 해당하는 구체적인 설명 정보
success Boolean API 성공 여부: 성공은 true, 실패는 false
traceId String traceId, 각 요청 상황을 추적하는 데 사용됩니다.

성공 및 실패 응답 예시

성공 응답:

{
    "code": 200,
    "content": {},
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

실패 응답(요청 JSON 형식 오류):

{
    "code": 400,
    "content": {"reason": "Expecting value", "line": 1, "column": 10},
    "errorCode": "ft.RequestJsonFormatError",
    "message": "请求 JSON 格式错误",
    "success": false,
    "traceId": "TRACE-XXXX"
}

문서 평가

이 페이지가 도움이 되었나요?