RestFul 한 API의 HTTP Response Code

📝 RestFul 한 API의 HTTP Response Code

Restful한 API를 만들기 위해서 HTTP Response Code에 대해서 정리해보려고 한다.
정확한 HTTP Response Code가 Client에 전달되어야 Front-end 개발자들이 개발 및 판단에 도움이 되기 때문에 정리해보려고 한다.

기본적인 HTTP Response Code의 체계는 다음과 같다.

Code 대역	분류	설명
1 x x	정보	Client에서 요청을 받고 프로세스를 계속 진행
2 x x	성공	Client에서 요청을 성공적으로 받고, 인식했으며 요청을 수용
3 x x	리다이렉션	Client의 요청을 완료하기 위한 추가 작업 필요
4 x x	클라이언트 오류	Client의 요청의 문법이 잘못되거나, 처리 불가
5 x x	서버 오류	Client의 유효한 요청을 받았으나, 서버에서 명백한 오류 발생

---

🚩 Response Code - 1XX ( 정보 )

• 해당 Response Code는 HTTP 1.0에서 지원되지 않음

🔨 100 - Continue

Server가 진행 중임을 의미하는 Response Code.
현재까지의 진행상태에 문제가 없으며, Client가 요청을 하거나 이미 요청을 완료한 경우에는 무시해도 된다는 것을 알려줌.

🔨 101 - Switching Protocol

Client가 보낸 업그레이드 요청 헤더에 대한 응답으로 보내집니다.
→ WebSocket으로 전환시에 사용되는 Response Code

🔨 102 - Processing(WebDAV)

서버가 요청을 수신하였으며 이를 처리하고 있지만, 아직 제대로 된 응답을 알려줄 수 없음

🚩 Response Code - 2XX ( 성공 )

🔨 200 - OK

Client 요청이 성공적이므로 요청에 대한 정보를 응답으로 반환.

🔨 201 - Created

Client 요청이 성공적이며, 해당 요청으로 새로운 리소스가 생성됨.
→ 일반적으로 Post, Put 요청에 사용됨.

🔨 202 - Accepted

Client 요청을 수신하였으나 그에 응하여 행동할 수 없음.
→ 해당 요청에 대한 응답을 비동기로 Client에게 줄지 장담할 수 없음.
→ 이 Response Code는 서버가 다른 프로세스에서 처리, 요청, 배치 프로세스를 하고 있는 경우 때문에 만들어짐.

🔨 203 - Non-Authoritative Information

Client로 부터 받은 메타 정보 세트가 오리진 서버의 것과 일치하지 않지만 로컬이나 서드 파티 복사본에서 모아졌음을 의미하며, 위와 같은 조건에서 해당 Reponse Code가 아닌 200 - OK Response Code를 반드시 우선해야한다.

🔨 204 - No Content

Client의 요청에 대해서 보내줄 수 있는 컨텐츠가 없음을 의미한다.
하지만 헤더는 의미 있을 수 있고, 캐시된 헤더를 새로운 헤더로 업데이트 할 수 있다.

🔨 205 - Reset Content

Client의 요청을 완수한 이후에 Client에게 이 요쳥을 보낸 문서 뷰를 리셋하라는 명령.

🔨 206 - Partial Content

Client에서 복수의 스트림을 분할 다운로드 하고자 범위 헤더를 전송했을 때 사용.
Client가 이어받기를 시도하면 Web Server가 이에 대한 응답코드로 해당 코드와 함께 Range 헤더에 명시된 데이터의 부분부터 전송을 시작함.

🔨 207 - Multi-Status

여러 리소스가 여러 상태 코드인 상황이 적절한 경우에 해당되는 정보를 전달.
→ 해당 코드는 WebDAV에 사용.

🔨 208 - Already Reported

Porstat ( Property + Status 합성어 ) 응답 속성으로 동일 컬렉션으로 바인드된 복수의 내부 멤버를 반복적으로 열거하는 것을 피하기 위해 사용.
→ 해당 코드는 WebDAV에 사용.

🔨 226 - IM Used ( HTTP Delta encoding )

Server가 Get요청에 대한 리소스의 의무를 다 했고, 응답이 하나 또는 그 이상의 인스턴스 조작이 현재 인스턴스에 적용 됐음을 알려줌.

🚩 Response Code - 3XX ( 리다이렉션 )

🔨 300 - Multiple Choice

request에 대해서 하나 이상의 응답이 가능하며, Client는 그중 하나를 반드시 선택해야함.
응답 중 하나를 선택하는 방법에 대한 표준은 존재하지 않음.

🔨 301 - Moved Permanently

request의 URI가 변경되었음을 의미함.
Restful 단계에 따라서 새로운 URI가 제공될 수 있음.

🔨 302 - Found

request의 URI가 일시적으로 변경되었거나 만드는중이라는 것을 의마하므로 Client는 향후의 요청도 해당 URI로 진행하면 됨.

🔨 303 - See Other

Client가 요청한 리소스를 다른 URI에서 Get 요청을 통해서 얻어야할 때 Server가 Client로 직접 보내는 응답.

🔨 304 - Not Modified

캐시의 목적으로 사용되며, Client에게 응답이 수정되지 않았음을 알려준다.
따라서 Client는 계속해서 캐시된 버전을 사용할 수 있다는 것을 알려준다.

🔨 305 - Use Proxy

이전 버전의 HTTP 기술 사양에서 정의되었으며, request의 응답은 반드시 프록시를 통해서 접속해야한다고 알려주는 응답.
해당 응답은 proxy의 in-band 설정에 대한 보안상의 걱정으로 인하여 점점 사라져가는 추세.

🔨 306 - Unused

해당 응답은 더이상 사용되지 않으나 현재는 추후 사용을 위해 예약되어 있다는 응답.
위 응답은 HTTP 1.1 기술사양 이전 버전에서 사용되었다.

🔨 307 - Temporary Redirect

Client가 request한 리소스가 다른 URI에 있으며, 이전 요청과 동일한 HTTP Method를 사용하여 요청해야할 때 Server가 Client에 이 응답을 직접 보낸다.
해당 응답은 302 응답과 동일한 의미를 가지고 있으나 Client가 HTTP Method를 변경하지 말아야한다는 점만 다르다.

🔨 308 - Permanent Redirect

Client가 request한 리소스가 영구히 다른 URI로 변경되었다는 것을 의미한다.
해당 응답은 301 응답과 동일한 의미를 가지고 있으나 Client가 HTTP Method를 변경하지 말아야한다는 점만 다르다.

🚩 Response Code - 4XX ( 클라이언트 오류 )

🔨 400 - Bad Request

Client가 잘못된 문법으로 접근하여 서버가 request를 이해할 수 없다는 응답.

🔨 401 - Unauthorized

Client가 인증되지 않았다는 의미의 응답.
→ HTTP 표준에서는 '미승인'으로 명확하게 하고 있지만 의미상 '미인증'으로 사용됨.

🔨 402 - Payment Required

해당 응답코드는 디지털 결제 시스템에 사용하기 위해서 만들어졌지만 현재는 사용되고 있지 않다.

🔨 403 - Forbidden

Client가 리소스에 접근할 권리를 가지고 있지 않다는 응답.
→ 401 과 다른 점은 Client가 누군지는 Server에서 인식하고 있음.

🔨 404 - Not Found

브라우저에서는 알려지지 않은 URI를 의미하며, API의 종점을 적절하지만 리소스를 Server가 찾을 수 없음을 의미한다.
→ Server들은 인증받지 않은 Client로 부터 리소스를 숨기기위하여 403 대신에 전송할 수 도 있다.

🔨 405 - Method Not Allow

Client의 request에 HTTP Method가 적절하지 않을때 Server에서 보내주는 응답.

🔨 406 - Not Acceptable

Client의 request에 맞는 규격의 어떠한 리소스도 존재하지 않을때 Server에서 보내는 응답.

🔨 407 - Proxy Authentication Required

401 응답과 비슷하지만 proxy에 의해 완료된 인증이 필요하다.

🔨 408 - Request Timeout

Client의 request 시간이 오래된 연결에 응답으로 보내지며, Server가 사용되지 않는 연결을 끊고싶어할 때도 사용함.

🔨 409 - Conflict

Server의 상태와 충돌될때 보내는데 대표적으로 데이터 충돌시에 주로 사용하였다.

🔨 410 - Gone

Client가 원한 리소스가 Server에서 영구적으로 삭제되고, 전달해 줄수 있는 주소 역시 존재하지 않을 때 사용하는 응답.

🔨 411 - Length Required

Client의 request header에 정보가 제대로 채워지지 않았을 때 발생하는 응답.

🔨 412 - Precondition Failed

Client의 header에 있는 전제 조건이 Server의 전제 조건과 맞지 않을 때 응답.

🔨 413 - Payload Too Large

Client의 request payload가 너무 클 때의 응답.
Server에서는 연결을 끊을 것.

🔨 414 - URI Too Long

Client의 request URI가 서버에서 처리하기로 한 길이보다 길 경우의 응답.

🔨 415 - Unsupported Media Type

Client의 request media Type은 지원하지 않을 경우의 응답.

🔨 416 - Requested Range Not Satisfiable

Client의 request URI 데이터의 크기를 벗어났을수도 있는 상황에 보내는 응답.
→ 확정적은 아니나 가능성이 있을 경우 사용.

🔨 417 - Expectation Failed

Expect 요청 헤더 필드로 요청한 예상이 Server에서는 적당하지 않음.

🔨 418 - I'm a teapot

예능 같으므로 패스 ~

🔨 421 - Misdirected Request

Client의 request는 Server에서 응답을 생성할 수 없을 경우의 응답.

🔨 422 - Unprocessable Entity ( WebDav )

문법 오류로 인하여 응답을 생성 불가한 경우의 응답.

🔨 423 - Locked ( WebDav )

리소스에 접근이 막혀있거나, 해당 리소스 접근이 잠겨있는 경우의 응답.

🔨 424 - Failed Dependency ( WebDav )

이전의 request가 실패하여서 연속된 request가 실패하였을 경우의 응답.

🔨 426 - Upgrade Required

해당 request의 protocol이 맞지 않아서 server가 처리하는 것을 거절하였지만
Client가 protocol을 업그레이드 하여 재요청 할 경우 처리가 가능할 때의 응답.
→ Server가 응답에 해당 protocol에 대한 정보를 보내주어야 함.

🔨 428 - Precondition Required

여러곳에서 데이터 변경 시 발생할 수 있는 '업데이트 상실'을 예방하기 위한 응답

🔨 429 - Too Many Requests

지정된 시간안에 너무 많은 request가 올 경우의 응답

🔨 431 - Request Header Fields Too Large

request의 header의 크기가 너무 클 경우, Server가 처리하지 않겠다는 응답.

🔨 451 - Unavailable For Legal Reasons

정부부처로부터 금지되어 불법적인 리소스를 Client가 request할 때 사용하는 응답.

🚩 Response Code - 5XX ( 서버 오류 )

🔨 500 - Internal Server Error

Server가 알 수 없는 이유로 문제가 생겼을 경우의 응답.

🔨 501 - Not Implemented

Server가 request에 대한 필요한 기능을 지원하지 않음을 나타냄.

🔨 502 - Bad Gateway

Server가 게이트웨이로부터 잘못된 응답을 수신했음을 의미하며 인터넷상의 Server가 다른 Server로 부터 유효하지 않은 응답을 받은 경우 발생함.

🔨 503 - Service Unavailable

Server가 request를 처리할 준비가 되지 않았음을 의미하는 응답.
→ 해당 응답에 대해서는 Client가 문제를 정확하게 알 수 있도록 응답에 알려주어야함.

🔨 504 - Gateway Timeout

Server가 다른 Server에 적절할 때 응답을 받지 못했음을 의미하므로 실제로 Server의 문제이거나 네트워크 문제일 가능성이 있을 때 해당 응답을 보냄.

🔨 505 - HTTP Version Not Supported

Server가 지원하지 않는 Version의 HTTP 요청이 들어왔을 때 응답을 보냄.

🔨 506 - Variant Also Negotiates

Server의 내부 구성에 오류가 있을 경우 보내는 응답.

🔨 507 - Insuffcient Storage

원하는 리소스에 내부 구성 오류가 있는 경우에 보내는 응답.

🔨 508 - Loop Detected ( WebDav )

Server가 응답을 만드는 동안 무한 루프가 감지되는 경우 보내는 응답.

🔨 510 - Not Extended

Server가 해당 응답을 만드려면 추가 확장이 필요한 경우의 응답.

🔨 511 - Network Authentication Required

Server가 네트워크 인증이 안되어서 응답을 줄 수 없는 경우 발생

---

📌 마무리

Restful한 API를 만들기 위해서 HTTP Response Code에 대해서 정리하였다.
생각보다 다양한 Response Code가 있으며, 잘 정리되어 있지만 실무보다는 이론적으로 너무 많이 접근해서 정한 것이 아닌가라는 생각이 들기도 하였다.
잘 숙지해서 사용해야겠다.