[FastAPI] API Status Code 정리

서론

---

그 동안 웹 개발을 해오면서 수 많은 api 에러코드를 보고 디버깅도 해 보았지만 정확하게 정리해보려 한 적은 없다. 이번 FastAPI 공부에 앞서 API Status Code를 정리해놓고 두고두고 보려 한다.

Status Code

---

2xx

• 200 OK : 요청 성공, GET/POST/PUT/PATCH에서 범용적으로 사용
• 201 Created : 요청 성공, 새로운 자원 생성, POST
• 204 No Content : 요청 성공, 응답할 자원 없음, DELETE

4xx

• 400 Bad Request : 요청 실패, 요청이 잘못된 경우 (query param, body)
• 401 Unauthorized : 인증 실패
• 403 Forbidden : 권한 문제 또는 잘못된 메서드
    > Spring Security에서 권한 없이 권한이 필요한 페이지에 접근했을 경우 발생했었음
• 404 Not Found : 자원이 없는 경우 또는 잘못된 endpoint
    > 가장 많이 보는 에러, 잘못된 endpoint는 요청 후 문제가 발생했으나 그 문제에 해당하는 에러 페이지를 찾지 못했을 경우 발생하 는 404를 말하는 것 같다

5xx

• 500 Internal Server Error : 범용적인 서버 에러
• 502 Bad Gateway : Reserve Proxy에서 서버의 응답을 처리할 수 없는 경우
    > 구글에서 작성된 지 오래된 페이지를 열 때, 또는 서버가 터졌을 때 많이 봤던 것 같다.
• 503 Service Unavailable : 서버가 요청을 처리할 수 없는 경우 (e.g. 일시적인 부하, 서버 다운)
    > 역시 서버가 터졌을 때 자주 봤던 것 같다.