API

API JSON 형식의 RESPONSE 데이터 기본 구조

pipinstall 2023. 4. 10. 10:38

JSON은 간단하고 가벼운 형식으로 데이터를 전달하기에 적합하며.
JSON 응답의 기본 구조는 아래와 같습니다.

{
  "status": "success",
  "data": {
    // 데이터 내용
  },
  "message": "요청이 성공적으로 처리되었습니다."
}

status: 요청 처리 결과를 나타내는 상태 코드입니다. 일반적으로 "success" 또는 "error" 값을 가집니다.
data: 요청 결과 데이터가 포함되는 객체입니다. 데이터가 없는 경우 빈 객체 {}가 반환됩니다.
message: 요청 처리 결과에 대한 설명이 포함되는 문자열입니다. 일반적으로 성공 또는 실패 이유를 설명합니다.


실제 API에서는 더 많은 속성이 포함될 수 있습니다. 

예를 들어, API 버전, 요청 ID, 시간 정보 등이 추가될 수 있습니다.