<aside> 💡 Ruflu Server API 통신을 하기 위한 명세서

</aside>

1. API 명세서 가이드 라인

1-1. Request 데이터 형식

1-2. Response 데이터 형식

key value
code 응답 코드
message 응답 메세지
result 실제 데이터 값 
{
	"code" : "",
	"message" : "",
	"result" : "" 
}

1-3. Base Url

Base Url 설명
www.ruflu.com/api - Ruflu Server API 통신을 위한 BASE URL

1-4. Response Code, Message

CODE STATE MESSAGE 설명
200 OK 요청을 성공적으로 처리
400 Bad Request 잘못된 요청 구문
401 Unauthorized 지정한 리소스에 대한 엑세스 권한이 없음을 의미
403 Forbidden 401 이외에 사유로 리소스 접근이 금지
404 Not Found 지정한 리소스를 찾을 수 없다.
408 Request Time Out 요청을 기다리다가 서버에서 타임 아웃
429 Too Many Request 클라이언트가 주어진 시간 동안 너무 많은 요청을 했다.
5XX 서버 오류 서버 오류

2. 기능별 명세서

| URL | 해당 api 주소 구성 : base url + URL | | --- | --- | | Method | HTTP Method 상태, (GET, POST, PUT, DELETE) | | Request(Body or Param) | 요청 데이터 값 | | Response | 응답 데이터 값 Json 형식 (code, message, result) | | Exception | 예외 처리를 위한 내용 | | 설명 | 해당 요청에 대한 설명 |

기능별 명세서