상태 코드
클라이언트가 보낸 요청의 처리 상태를 응답에서 알려주는 기능
- 1xx (Informational): 요청이 수신되어 처리중
- 거의 사용되지 않는 코드
- 2xx (Successful): 요청 정상 처리
- 3xx (Redirection): 요청을 완료하려면 추가 행동이 필요
- 4xx (Client Error): 클라이언트 오류, 잘못된 문법 등으로 서버가 요청을 수행할 수 없음
- 5xx (Server Error): 서버 오류, 서버가 정상 요청을 처리하지 못함
상태 코드는 각 회사, 팀에서 어디까지만 사용하자고 정의하고 사용하는 경우가 많다.
너무 많은 상태코드가 존재하기 때문.
2xx 성공(Successful)
200 OK
- 클라이언트 요청을 성공적으로 처리함을 의미
201 Created
- 클라이언트가 요청한 것을 가지고 서버에서 리소스를 생성하였을 경우
- 주로 POST 메서드로 등록하였을 떄 사용한다.
- 생성된 리소스는 서버측에서 응답의 Location 헤더 필드로 식별, 또는 body에 넣어준다.
202 Accepted
- 요청이 접수는 되었으나 처리가 완료되지 않음
- 배치 처리 같은 곳에서 사용
- 요청 접수 후 1시간 뒤에 배치 프로세스가 요청을 처리함
204 No Content
- 서버가 요청을 성공적으로 수행했지만, 응답 페이로드 본문에 보낼 데이터가 없음
- 웹 문서 편집기에서 sava 버튼
- save 버튼의 결과로 아무 내용이 없어도 된다.
- save 버튼을 눌러도 같은 화면을 유지해야한다.
- 결과 내용이 없어도 204 메시지만으로 성공을 인식할 수 있다.
3xx - 리다이렉션
요청을 완료하기 위해 유저 에이전트의 추가 작업이 필요한 경우
ex. 웹 브라우저는 3xx 응답의 결과에 Location 헤더가 있으면, Location 위치로 자동 이동(리다이렉트)
리다이렉션 종류
- 영구 리다이렉션 - 특정 리소스의 URI가 영구적으로 이동
- 원래의 URL를 사용하지 못함, 검색 엔진 등에서도 변경 인지할 수 있다
- /members -> /users
- /event -> /new-event
- 일시적인 리다이렉션 - 일시적으로 변경
- 검색 엔진 등에서 URL을 변경하면 안됨
- 주문 완료 후 주문 내역 화면으로 이동
- PRG: Post/Redirect/Get
- 특수 리다이렉션
- 결과 대신 캐시를 사용
300 Multiple Choices
301 Moved Parmanently(영구 리다이렉션)
- 리다이렉트 시 요청 메서드가 GET으로 변하고, 본문이 제거될 수 있음
- 클라이언트가 POST요청을 보낸다.
- 서버는 변경되기 전 URL로 요청이 온 POST요청을 받은 후 301 코드와 Location 헤더에 새로운 URL을 보낸다.
- 클라이언트는 전달받은 URL로 GET요청을 하게된다.
- 서버는 사용자가 다시 입력할 수 있도록 페이지를 띄워준다.
308 Permanent Redirect(영구 리다이렉션)
- 301과 기능이 같음
- 리다이렉트 시 요청 메서드와 본문을 유지한다.
- 클라이언트가 POST 요청을 보낸다.
- 서버는 변경되기 전 URL로 요청이 온 POST 요청을 받은 후 308 코드와 Location 헤더에 새로운 URL을 보낸다.
- 클라이언트는 전달받은 URL로 POST 요청을한다(POST 유지)
- 서버는 전달받은 POST 요청으로 리소스를 만들어준다.
실무에서는 301처럼 사용하는 부분이 많음
302 Found(일시 리다이렉션)
- 리다이렉트 시 요청 메서드가 GET으로 변하고, 본문이 제거될 수 있음
307 Temporary Redirect(일시 리다이렉션)
- 302와 기능은 같음
- 리다이렉트 시 요청 메서드와 본문 유지(요청 메서드를 변경하면 안된다)
303 See Other(일시 리다이렉션)
- 302와 기능은 같음
- 리다이렉트 시 요청 메서드가 GET으로 변경
PRG: Post/Redirect/Get
- 일시적인 리다이렉션
- 문제 : POST로 주문 후 웹 브라우저를 새로고침 하면? -> 새로고침은 다시 요청 -> 중복 주문이 될 수 있다.
- 해결 방안: PRG 패턴을 사용한다.
- POST로 주문 후 새로 고침으로 인한 중복 주문 방지
- POST로 주문 후 Server는 주문 결과 화면을 GET 메서드로 리다이렉트해준다.
- ex. 302 Found / Location: 리다이렉트할 URL
- 클라이언트는 새로고침해도 결과 화면을 GET으로 조회하게 된다.
- ex. GET /서버에서 넘어온 URL
- 클라이언트는 중복 주문 대신에 결과 화면만 GET으로 다시 요청
- PRG 패턴 이후 리다이렉트
- GET으로 리다이렉트 되기 때문에 새로고침 해도 Client는 GET으로 화면 조회만 하게됨
302, 307, 303 무엇을 써야할까?
- 302 Found -> GET으로 변할 수 있다
- 스펙의 의도는 HTTP 메서드를 유지하는 것
- 하지만 웹 브라우저들이 대부분 GET으로 바꿔버림
- 그래서 모호한 302를 대신하는 307, 303이 등장하게됨(301 대응으로 308등장)
- 307, 303을 권장하지만 많은 애플리케이션 라이브러리들이 302를 기본값으로 사용
- 리다이렉션 시 GET으로 변해도되면 그냥 302를 사용해도 큰 문제 없음
- 307 Temporary Redirect -> 메서드가 변하면 안된다.
- 303 See Other -> 메서드가 GET으로 변경
300 Multiple Choices: 안씁니다.
304 Not Modified(많이 쓴다.)
- 캐시를 목적으로 사용한다.
- 클라이언트에게 리소스가 수정되지 않았음을 알려준다. 클라이언트는 로컬 PC에 저장된 캐시를 재사용한다.(캐시로 리다이렉트 해줘야함)
- 304 응답은 응답에 메시지 바디를 포함하면 안된다. (로컬 캐시를 사용해야하므로)
- 조건부 GET, HEAD 요청시 사용한다.
4xx - 클라이언트 오류(Client Error)
- 클라이언트의 요청에 잘못된 문법등으로 서버가 요청을 수행할 수 없을 경우
- 오류의 원인이 클라이언트에 있다.
- 클라이언트가 애초에 잘못된 요청을 보내기 때문에 똑같은 재시도를 해도 실패한다.
- 요청을 수정해서 보내야한다.
400 Bad Request
클라이언트가 잘못된 요청을해서 서버가 요청을 처리할 수 없는 상태
- 요청 구문, 메시지 등 오류
- 클라이언트는 요청 내용을 다시 검토하고 보내야한다.
- 요청 파라미터가 잘못되었거나, API 스펙에 맞지 않는 요청을 보냈을 경우
401 Unauthorized
클라이언트가 해당 리소스에 대한 인증이 필요함
- 인증(Authentication) 되지 않음
- 401 오류 발생 시 응답에 WWW-Authenticate 헤더와 함께 인증 방법을 설명
- 인증(Authentication): 로그인할 수 있다 없다
- 인가(Authorization): 로그인한 사용자에 대한 권한 등급 (Admin 권한 처럼 특정 리소스에 접근할 수 있는 권한 인증이 있어야 인가가 있음)
- 오류 메시지가 Unauthorized 이지만 인증(Authentication)이 안되었다고 보는게 맞다.
403 Forbiddent
서버가 요청을 이해했지만 승인을 거부함
- 주로 인증 자격 증명은 있지만, 접근 권한이 불충분한 경우
- Admin 등급이 아닌 사용자가 로그인은 하였지만 Admin 등급에 접근하는 경우
404 Not Found
요청 리소스를 찾을 수 없음
- 요청 리소스가 서버에 없음
- 또는 클라이언트가 권한이 부족한 리소스에 접근할 때 해당 리소스를 숨기고 싶을 때
5xx - 서버 오류(Server Error)
- 서버에 원인이 있다.
- 서버의 문제이기 때문에 클라이언트가 요청을 수정해서 보내지 않아도 된다.
- 서버에 문제가 있기 때문에 재시도하면 성공할 수도 있다.(서버 복구가 되었을 경우)
- 웬만하면 500대 에러는 만들지 않도록 해야한다.
- 500에러는 서버에 정말 문제가 있을 경우에만 사용해야 한다.
500 Internal Server Error
서버 문제로 오류 발생, 애매하면 500 오류
- 서버 내부 문제로 오류 발생
- 애매할 땐 500 오류
503 Service Unavailable
서비스 이용 불가
- 서버가 일시적인 과부하 또는 예정된 작업으로 잠시 요청을 처리할 수 없다
- Retry-After 헤더 필드로 얼마 뒤에 복구되는지 보낼 수도 있다
좋은 개발자가 되고싶은