API 명세서

API 명세서

성공 실패 방식 정의

이렇게 정리해주세요! (참고용 사진)

image.png

아래와 같은 방식으로 백엔드 API 반환 예정

✅ 성공 예시

{
  "httpStatus": "OK",
  "isSuccess": true,
  "message": "요청에 성공하였습니다.",
  "code": 200,
  "result": {
    "uuid": "520c63d1-76e2-482c-bcda-49033d1ae63e",
    "role": "ADMIN"
  }
}

🚫 실패 예시

{
  "httpStatus": "INTERNAL_SERVER_ERROR",
  "isSuccess": false,
  "message": "Bad credentials",
  "code": 500,
  "result": "서버에서 예기치 않은 오류가 발생했습니다."
}
to. 혜원, 석재

400번대는 커스터마이징 x (프론트 잘못이라고 생각할 수 있음)