응답 코드는 요청에 대한 상태를 나타내는 HTTP 상태 코드(Status code)
요청 성공 및 실패할 경우, HTTP 상태 코드와 함께 요청에 대한 응답 바디(response body)가 반환
| 상태 코드 | 상태 | 설명 |
|---|---|---|
| 200 OK | 성공 | 서버가 클라이언트의 요청을 성공적으로 수행 |
응답 바디의 경우 각 API별로 응답 바디의 형식이 다를 수 있다. | | 201 Created | 성공 | 요청이 성공적이었으며 그 결과, 새로운 리소스 생성
POST 요청에 대한 응답 결과로 사용한다. | | 400 Bad Request | 실패 | 잘못된 문법으로 인하여 서버가 요청을 이해할 수 없음을 의미한다.
(예시 : 필수 파라미터와 관련한 잘못된 요청 구문) | | 401 Unauthorized | 실패 | 인증 오류(주로 토큰 관련) 해당 리소스에 유효한 인증 자격 증명이 없기 때문에 요청이 적용되지 않았음을 의미한다. | | 403 Forbidden | 실패 | 인증 오류(주로 토큰 관련) 해당 리소스에 유효한 인증 자격 증명이 없기 때문에 요청이 적용되지 않았음을 의미한다. | | 404 | 실패 | | | 409 Conflict | 실패 | 요청이 현재 서버의 상태와 충돌 될 때 보낸다. (충돌은 PUT 요청에 대응하여 발생할 가능성이 높다.) | | 500 Internal Server Error | 실패 | 시스템 오류 서버 에러를 총칭하는 에러 코드로, 요청을 처리하는 과정에서 서버가 처리 방법을 모르는 상황임을 의미한다. | | 502 Bad Gateway | 실패 | 시스템 오류 서로 다른 프로토콜을 연결해주는 게이트웨이가 잘못된 프로토콜을 연결하거나, 연결된 프로토콜에 문제가 있어 통신이 제대로 되지 않은 상태이다. | | 503 Service Unavailable | 실패 | 서비스 점검 중 서버가 요청을 처리할 준비가 되지 않은 상태다. |
API 명세서 표 URI 사이드 바에 요청/응답 예시가 있습니다.
요구사항 정의서 내에 API명세서 시트가 있습니다.