[TIL] 22.12.15 HTTP 메서드 활용, 상태코드

김영한님의 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 듣고 정리한 내용입니다.

https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC

모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런 | 강의

 

HTTP 메서드 활용

HTTP API 설계 예시

• 컬렉션 - POST 기반 등록
• 스토어 - PUT 기반 등록
• HTML FORM 사용

 

API 설계 - POST 기반 등록

회원 관리 시스템 예시

• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

수정을 할 때 PUT은 기존의 데이터를 지우기 때문에 회원 데이터를 수정할 때는 PATCH를 쓰는 것이 좋다. (PUT은 게시글 수정처럼 기존 데이터를 덮어버려도 괜찮은 경우에 사용하면 좋다. 애매한 경우에는 POST를 쓰면 된다.)

 

특징

• 클라이언트는 등록될 리소스의 URI를 모름
• 서버가 새로 등록된 리소스 URI를 생성해줌
• 컬렉션(Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

 

API 설계 - PUT 기반 등록

파일 관리 시스템 예시

• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST

새로운 파일을 업로드하는 경우에는 PUT이 적합하다.

 

특징

• 클라이언트가 리소스 URI를 알고 있어야 함
• 클라이언트가 직접 리소스의 URI를 지정
• 스토어(Store)
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 여기서 스토어는 /files

 

HTML FORM 사용

HTML FORM은 GET과 POST만 지원한다. (여기서는 순수 HTML, HTML FORM을 말하는 것이다.) 그렇기 때문에 설계에 제약이 있다. 이런 제약을 해결하기 위해 동사로 된 리소스 경로(컨트롤 URI)를 사용하는 것이 좋다.

• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
• 회원 등록 /members/new -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit -> POST
• 회원 삭제 /members/{id}/delete -> POST

 

---

 

HTTP 상태코드

HTTP 상태코드 소개

HTTP 상태코드는 클라이언트가 보낸 요청의 처리 상태를 응답에서 알려주는 기능이다.

• 1xx(Informational): 요청이 수신되어 처리 중
• 2xx(Successful): 요청 정상 처리
• 3xx(Redirection): 요청을 완료하려면 추가 행동이 필요
• 4xx(Client Error): 클라이언트 오류
• 5xx(Server Error): 서버 오류

만약 생소한 상태 코드를 서버가 반환할 경우 클라이언트에서는 상위 상태코드로 해석해서 처리하면 된다. (만약 모르는 상태 코드 299가 나왔을 때 2xx이므로 성공으로 간주하면 된다.)

 

1xx(Informational)

요청이 수신되어 처리 중임을 뜻한다. 거의 사용하지 않는다.

 

2xx(Successful)

클라이언트의 요청을 성공적으로 처리함을 뜻한다.

• 200 OK - 요청 성공
• 201 Created - 성공해서 새로운 리소스가 생성됨
• 202 Accepted - 요청이 접수되었으나 처리가 완료되지 않았음
• 204 No Content - 서버가 요청을 성공적으로 수행했지만, 응답 페이로드 본문에 보낼 데이터가 없음

202의 경우 배치 처리 같은 곳에서 사용한다. (ex. 요청 접수 후 1시간 뒤에 배치 프로세스가 요청을 처리함)

 

204의 경우 성공 여부만 알고 굳이 서버에서 메시지를 받을 필요가 없을 때 사용한다.

 

성공 코드의 경우 200만 사용하는 경우도 많고, 200과 201만 쓰자고 하는 경우도 있다. 사용하는 상태코드가 너무 많아도 일일히 처리해주기 복잡하기 때문에 개발할 때 팀에서 정해놓고 사용하는 것이 좋다.

 

3xx(Redirection)

요청을 완료하기 위해 유저 에이전트의 추가 조치가 필요함을 뜻한다. (유저 에이전트는 클라이언트 프로그램, 주로 웹 브라우저를 말한다.)

• 300 Multiple Choices
• 301 Moved Permanently
• 302 Found
• 303 See Other
• 304 Not Modified
• 307 Temporary Redirect
• 308 Permanent Redirect

 

리다이렉션 이해

웹 브라우저는 3xx 응답의 결과에 Location 헤더가 있을 경우 Location 위치로 자동으로 이동하게 되는데, 이를 리다이렉트라고 한다.

 

만약 예전에 이벤트 페이지를 만들었는데 현재는 쓰지 않고, 새로운 이벤트 페이지를 사용하기로 했다고 하자.

기존의 사용자들은 예전의 링크를 북마크해놨을 수도 있고, 기존의 링크가 인터넷에 공유되어 있을 수도 있다.

 

그럴 경우 /event의 경로로 들어왔을 때 서버 입장에서는 /event를 더이상 쓰지 않는다는 것을 알려주기 위해 301 코드와 Location의 위치를 준다.

 

그렇게되면 브라우저는 스스로 해당 Location으로 url를 바꾸게 되고, 새로운 경로에서 요청을 다시 하게 된다.

 

리다이렉션 종류

• 영구 리다이렉션 - 특정 리소스의 URI가 영구적으로 이동
• 일시 리다이렉션 - 일시적인 변경. 잠깐 이동시킬 때 사용하며 주문 완료 후 주문 내역 화면으로 이동할 때 가장 많이 사용. PRG 패턴(Post/Redirect/Get)
• 특수 리다이렉션 - 결과 대신 캐시를 사용

 

영구 리다이렉션 - 301, 308

리소스의 URI가 영구적으로 이동된다.

원래의 URL을 사용하지 않으며, 이를 검색 엔진에서도 변경되었음을 인지한다.

• 301 Moved Permanently
  • 리다이렉트 시 요청 메서드가 GET으로 변하고(POST로 요청을 했어도), 본문이 제거될 수도 있음(MAY)
• 308 Permanent Redirect
  • 301과 기능은 같음
  • 리다이렉트 시 요청 메서드와 본문을 유지(처음에 POST로 보내면 리다이렉트 후에도 POST)

301은 메시지가 존재했는데 리다이렉션이 된다면 body가 없어져서 새로 이동된 페이지에서 아까 입력한 내용을 처음부터 다시 입력해야 하는 경우가 발생한다.

308은 요청 메서드와 본문을 유지하기 때문에 이런 문제를 해결할 수 있다.

 

하지만 보통 새로운 URL로 리다이렉트하는 경우 보통 새로운 페이지로 보내야하는 내부적인 정보들이 바뀌기 때문에 이전에 입력했던 내용을 유지할 필요가 없다. 따라서 실제로는 위의 예시처럼 사용하지는 않는다.

 

일시적인 리다이렉션 - 302, 307, 303

리소스의 URI가 일시적으로 변경된다. 따라서 검색 엔진 등에서 URL을 변경하면 안된다.

• 302 Found
  • 리다이렉트 시 요청 메서드가 GET으로 변하고, 본문이 제거될 수 있음(MAY)
• 307 Temporary Redirect
  • 302와 기능은 같음
  • 리다이렉트 시 요청 메서드와 본문 유지(요청 메서드를 변경하면 안된다.)
• 303 See Other
  • 302와 기능은 같음
  • 리다이렉트 시 요청 메서드가 GET으로 변경(무조건. 302는 불확실)

302의 경우 GET으로 변하고, 본문이 제거될 수 있기 때문에 보통 307과 303을 쓰기를 권장한다. 하지만 실제로는 대부분 302를 많이 사용한다.(대부분 프레임워크, 라이브러리를 보면 리다이렉트의 디폴트가 302이다.)

 

PRG: Post/Redirect/Get

PRG 사용 전

 

마우스 1개를 주문했다는 것을 POST로 보냈다고 하자. 서버에서는 주문 데이터를 저장하고 주문이 완료되었다는 메시지를 보낸다.

그런데 만약 주문이 완료된 후 결과 화면에서 다시 새로고침을 한다면, 브라우저는 새로고침 시 마지막 요청을 다시 보내기 때문에 POST 요청이 다시 가게 된다. 이런 경우 중복 주문이 발생한다.

 

PRG 사용

PRG 패턴을 사용하면 위의 문제를 해결할 수 있다.

1. 클라이언트에서 마우스 1개 주문을 POST로 보낸다.
2. 서버에서 주문데이터를 저장한다.
3. 클라이언트에게 302 상태코드와 Location을 보낸다.
4. 응답 메시지에 Location이 왔기 때문에 브라우저는 자동으로 그 URL로 이동한다.
5. 클라이언트 쪽에서 해당 Location으로 요청 메서드를 GET으로 변경해 다시 요청을 한다.
6. 서버는 해당 주문 데이터를 조회해 주문 결과를 보내준다.

이렇게 하면 실수로 주문 결과 화면에서 새로고침을 해도 마지막 요청이 GET이었기 때문에 POST 요청이 다시 가지 않게 된다.

 

정리

 

처음 302 스펙의 의도는 기존에 보냈던 HTTP 메서드를 유지하는 것이었다. 하지만 대부분의 웹 브라우저들이 메서드를 GET으로 바꾸도록 구현해버려 모호해졌다. 따라서 이를 대신하기 위해 명확한 307과 303이 등장했다.

 

명확한 307과 303을 권장하긴 하지만, 현실적으로 이미 많은 애플리케이션 라이브러리들이 302를 기본값으로 사용하고 있기 때문에 자동 리다이렉션 시에 GET으로 변해도 된다면 그냥 302를 사용해도 큰 문제가 없다.

 

기타 리다이렉션 - 304 Not Modified

캐시를 목적으로 사용한다.

클라이언트에게 리소스가 수정되지 않았음을 알려주어 클라이언트가 로컬 PC에 저장된 캐시를 재사용할 수 있도록 한다.

로컬 캐시를 사용해야 하기 때문에 304 응답은 응답 메시지에 바디를 포함하면 안된다.

조건부 GET, HEAD 요청 시 사용한다.

 

4xx(Client Error)

클라이언트 오류. 클라이언트의 요청에 잘못된 문법 등으로 서버가 요청을 수행할 수 없음을 의미한다.

오류의 원인이 클라이언트에 있고, 클라이언트가 이미 잘못된 요청을 보내고 있기 때문에 재시도를 해도 똑같이 실패하게 된다. 따라서 요청을 수정하지 않는 한 계속 같은 오류가 발생한다.

 

400 Bad Request

클라이언트가 잘못된 요청을 해서 서버가 요청을 처리할 수 없음을 의미한다.

 

요청 구문, 메시지 등에 오류가 있을 때 사용되며, 클라이언트는 요청 내용을 다시 검토하고 보내야 한다.

예) 요청 파라미터가 잘못되거나, API 스펙이 맞지 않을 때

 

401 Unauthorized

클라이언트가 해당 리소스에 대한 인증(Authentication)이 필요함을 뜻한다.

 

401 오류 발생 시 응답에 WWW-Authenticate 헤더와 함께 인증 방법을 설명해줘야 한다.

 

참고로 인증(Authentication)과 인가(Authorization)의 차이를 알면 좋은데 인증은 본인이 누구인지 확인하는 것, 즉 로그인 여부를 확인하는 것이고 인가는 admin처럼 특정 리소스에 접근할 수 있는 권한이 있는지 확인하는 것이다.

로그인을 해야 권한이 있는지 확인 가능하기 때문에 인증이 있어야 인가가 있다고 할 수 있다.

 

401의 메시지가 Unauthorized이지만 실제로는 권한에 대한 것이 아니라 인증, 즉 로그인에 대한 코드이다.

 

403 Forbidden

서버가 요청을 이해했지만 승인을 거부함을 뜻한다.

 

주로 인증 자격 증명은 있지만, 접근 권한이 불충분한 경우에 사용한다.

예) 어드민 등급이 아닌 사용자가 로그인은 했지만, 로그인 등급의 리소스에 접근하는 경우

 

404 Not Found

요청 리소스를 찾을 수 없음을 의미한다.

 

요청 리소스가 서버에 없을 때 또는 클라이언트가 권한이 부족한 리소스에 접근할 경우 해당 리소스를 숨기고 싶을 때 사용한다.

 

5xx(Server Error)

서버 오류. 서버 문제로 오류가 발생했을 때 사용한다.

서버에 문제가 있는 것이기 때문에 같은 요청을 재시도했을 때 성공할 수도 있다.

 

500 Internal Server Error

서버 문제로 오류가 발생함을 의미한다.

애매한 경우 500 오류를 사용하면 된다.

 

503 Service Unavailable

서비스 이용 불가. 서버가 일시적인 과부하 또는 예정된 작업으로 잠시 요청을 처리할 수 없음을 의미한다.

 

Retry-After 헤더 필드로 얼마 뒤에 복구되는지 보낼 수도 있다.