API 명세서

devkwon·2024년 1월 11일

기능

어떠한 기능을 사용할지 명세

URL

식별자 (최상단 디렉토리)
/user/login 이라면

/user

URI

식별자 + 위치 (하위 디렉토리)
/user/login 이라면

/login

HTTP Method

get,put,post 등 해당 restAPI가 어떤 메소드를 사용할지

설명

해당 기능에 대한 상세한 명세

Request Body

해당 API에 필요한 요청 값

{
  “id”:{user_id},
  “pw”:{user_pw}
}

Response Body

비즈니스 로직을 처리하고 되돌려줄 응답 값

{
  “result”:"success",
  “data”:...
}

0개의 댓글