<aside>
❗ richable API Reference
</aside>
API 명세
엔드포인트
HTTP 메서드
| HTTP 방식 |
메서드 |
| GET |
서버로부터 데이터를 취득 |
| POST |
서버에 데이터를 추가 ,작성 등 |
| PUT |
서버의 데이터를 갱신, 작성 등 |
| DELETE |
서버의 데이터를 삭제 |
상태 코드
성공 코드
| HTTP 상태 |
설명 |
| 200 |
클라이언트 요청 정상수행(응담에 대한 메세지 포함) |
| 201 |
리소스 생성 요청에 대한 정상처리 |
| 202 |
리소스 생성 요청이 비동기적으로 처리될 때 사용 |
| 204 |
클라이언트 요청 정상수행(응답에 대한 메시지 미포함,보통 삭제 요청에 사용) |
실패 코드
| HTTP 상태명 |
설명 |
| 400 |
클라이언트 요청이 부적절할때 사용(부적절한 이유를 응답 body에 넣어줘야 함) |
| 401 |
클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청할 때 사용 |
| 403 |
클라이언트가 인증 상태와 무관하게 응답하고 싶지 않은 리소스를 요청할 때 사용 |
| 404 |
클라이언트가 요청한 리소스가 존재하지 않을때 사용 |
| 405 |
클라이언트가 불가능한 메소드를 사용했을 때 |
| 500 |
서버 오류 |
응답 예시(JSON)
Success “Response”
{
"success": true,
"response": {
"user_id": 20,
"login_id": "aaa24",
"password": "1234",
"name": "name",
"nickname": null,
"email": "[email protected]",
"point": 0,
"profile_image": null,
"is_master": false,
"updatedAt": "2022-03-16T13:57:44.920Z",
"createdAt": "2022-03-16T13:57:44.920Z"
}
}
Failed “Response”
{
"success": false,
"message": "Spot not found with index: 63"
}