[백엔드] HTTP Status Code

HTTP Status Code

백엔드에서 REST API를 설계할 때, response로 상태에 알맞은HTTP Status Code를 작성해야 합니다. 모든 상태 코드를 외울 필요 없이, 공식 문서를 참고하여 사용하면 됩니다. 자주 사용하는 상태 코드를 정리해봤습니다.

 

공식 문서 - https://www.django-rest-framework.org/api-guide/status-codes/#status-codes

 

Suceesful - 2xx

2xx 코드는 클라이언트의 요청을 성공적으로 받았다는 의미입니다.

200과 204 code의 차이점은 GET은 항상 데이터를 받아와야 하지만, PUT/DELETE는 행위 성공 여부만 리턴 받아도 됩니다.

200 Ok            서버가 request를 성공적으로 처리했을 때 (GET/PUT/PATCH/DELETE)
201 Create        서버가 request를 성공적으로 처리하고 새 리소스를 만들었을 때 (POST)
202 Accepted      서버가 request만 받고, 아직 처리하지 않았을 때
204 No Content    서버가 request를 성공적으로 처리했고 contents는 제공하지 않았을 때 (PUT/PATCH)

 

Client Error - 4xx

클라이언트가 서버로 요청을 잘 못 보냈을 때 발생하는 코드입니다.

400 Bad Request	        잘못 요청했을 때
401 Unauthorized	인증이 만료되었을 때
403 Forbidden	        해당 페이지의 접근 권한이 없을 때
404 Page Not found	존재하지 않는 게시물을 요청했을 때
408 Request Timeout	연결 시간이 초과되었을 때

 

Server Error - 5xx

서버가 요청에 대해 제대로 수행하지 못했을 때 발생하는 코드입니다.

500 Internal Server Error  서버에 에러가 발생했을 때
502 Bad Gateway            서버가 잘못된 응답을 받았을 때
504 Gateway Timeout        게이트웨이 시간 초과