✏️ HTTP 메서드

박상민·2023년 8월 21일

HTTP 메서드 http

HTTP WEB 기본 지식

목록 보기

4/13

이미지 주소: http://www.lghnh.com/global/brand/detail.jsp?gbn=2&bid1=H125

❓ HTTP API를 만들어보자

요구사항

회원 목록 조회
회원 조회
회원 등록
회원 수정
회원 삭제

요구 사항을 위 5개라고 하자.

그렇다면 요구사항에 맞는 API URI를 설계해보자.

API URI 설계
URI(Uniform Resource Identifier)

회원 목록 조회 /read-member-list
회원 조회 /read-member-by-id
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member

아마 URI에 의미를 알 수 있게 위처럼 설계를 할 것이다.

그런데 과연 이것이 좋은 URI 설계일까?
URI를 설계할 때 가장 중요한 것은 리소스 식별이다.

API URI 고민

리소스의 의미는 뭘까?
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다!
- 예) 미네랄을 캐라 -> 미네랄이 리소스 (미네라를 캐라는 것이 리소스가 아니다. 미네랄이 리소스이다.)
- 회원이라는 개념 자체가 바로 리소스다.
  -> 회원을 조회하는 것이 리소스가 아닌 회원이라는 개념 자체가 바로 리소스이다.
리소스를 어떻게 식별하는게 좋을까?
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제
- 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑

그렇다면 다시 API URI를 설계해보자

API URI 설계

리소스 식별, URI 계층 구조 활용

• 회원 목록 조회 /members -> 회원 여러 개를 조회하는 것이니 members라고 하자.
• 회원 조회 /members/{id} -> 어떻게 구분할까?
• 회원 등록 /members/{id} -> 어떻게 구분할까?
• 회원 수정 /members/{id} -> 어떻게 구분할까?
• 회원 삭제 /members/{id} -> 어떻게 구분할까?

참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

리소스와 행위을 분리, 가장 중요한 것은 리소스를 식별하는 것

URI는 리소스만 식별!
리소스와 해당 리소스를 대상으로 하는 행위을 분리
- 리소스: 회원
- 행위: 조회, 등록, 삭제, 변경
리소스는 명사, 행위는 동사 (미네랄을 캐라)
행위(메서드)는 어떻게 구분?

일단 '회원' 자체를 리소스로 보고 URI를 설계했다. 그런데 조회, 등록, 수정, 삭제의 URI가 모두 똑같은데 어떻게 구분할까?
여기서 등장하는 것이 바로 오늘의 주제인 HTTP 메서드이다.

⭐️ HTTP 메서드

HTTP 메서드란 클라이언트와 서버 사이에 이루어지는 요청(Request)과 응답(Response) 데이터를 전송하는 방식을 일컫는다. 쉽게 말하면 서버에 주어진 리소스에 수행하길 원하는 행동, 서버가 수행해야 할 동작을 지정하는 요청을 보내는 방법이다.

주요 메서드
• GET: 리소스 조회
• POST: 요청 데이터 처리, 주로 등록에 사용
• PUT: 리소스를 대체, 해당 리소스가 없으면 생성
• PATCH: 리소스 부분 변경
• DELETE: 리소스 삭제

URI의 리소스만 식별해두면 HTTP 메서드인 GET, POST, PUT, DELETE가 조회, 등록, 삭제, 변경을 대신 해준다.

요즘은 리소스라는 말 대신 Representation을 사용하지만 익숙한 리소스로 설명하도록 하겠다.

기타 메서드
• HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
• CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정
• TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
CONNET, TRACE는 거의 사용하지 않는다. 참고만 하자

📌 GET

이름 그대로 리소스를 조회하는 메서드
서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
PATH에 있는 자원을 달라는 것
메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지
않음

리소스 조회

클라이언트가 서버에게 /members의 id가 100인 유저를 달라고 요청했다고 하자. 그러핟면 HTTP 메서드인 GET을 담은 메시지가 서버에 전달 된다. 서버는 GET 메서드가 있는 HTTP 요청 메시지를 받고 내부의 데이터 베이스를 조회해서 /members/100의 정보를 담은 응답 메시지를 만든다.

응답 데이터

서버는 클라이언트가 요청한 데이터를 Json등의 형태가진 응답 데이터를 만들어서 클라이언트에게 전달한다.

이것이 GET 메서드를 이용한 리소스 조회 과정이다.

📌 POST

요청 데이터 처리
메시지 바디를 통해 서버로 요청 데이터 전달
서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

POST는 클라이언트에서 서버에 요청을 할 때 데이터를 줄테니 서버가 요청 데이터를 처리해달라는 메서드이다.

POST는 만능이라고도 불린다. 이유는 뒤에서 설명하겠다.

메시지 전달

클라이언트가 서버에 처리를 부탁할 데이터인 username: young, age:20를 메시지에 담아서 보낸다.

신규 리소스 생성

서버는 메시지를 열어서 확인하고, 데이터 베이스에 등록한다.

응답 데이터

데이터를 데이터 베이스에 등록한 뒤 응답 데이터를 만들어서 클라이언트의 요청을 수행했다는 것을 알린다. 이때 등록된 자원에 대한 데이터를 Body에 포함한다.

201 Created는 신규 등록을 완료했다는 의미이고, Location은 자원이 생성된 경로를 나타낸다.

✔︎ 요청 데이터를 어떻게 처리한다는 뜻일까?

스펙: POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청합니다. (구글 번역)
예를 들어 POST는 다음과 같은 기능에 사용됩니다.
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
  - 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
  - 예) 게시판 글쓰기, 댓글 달기
- 서버가 아직 식별하지 않은 새 리소스 생성
  - 예) 신규 주문 생성
- 기존 자원에 데이터 추가
  - 예) 한 문서 끝에 내용 추가하기
정리: 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음

✔︎ POST 정리

1. 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
- 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
- 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST

📌 PUT

리소스를 대체
- 리소스가 있으면 대체
- 리소스가 없으면 생성
- 쉽게 이야기해서 덮어버림
중요! 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 URI 지정
- POST와 차이점

서버에 이미 리소스가 있는 경우

기존 서버에 /members/100에 username: young, age: 20인 데이터가 저장되어 있었다고 하자. 이때, 클라이언트에서 PUT으로 members/100에 username: old, age: 50인 데이터를 담아서 보낸다고 하자.

리소스 대체

같은 URI로 PUT이 오면 기존의 데이터는 완전히 삭제되고 전달 받은 데이터로 리소스가 완전히 대체된다.
이때 만약 서버에 리소스가 없다면?

서버에 리소스가 없는 경우

클라이언트에서 PUT으로 members/100에 username: old, age: 50인 데이터를 담아서 보낸다고 하자. 그런데 이번에는 이전과는 상황이 다르다.
서버에 /members/100이라는 리소스가 없다고 가장하자. 어떻게 될까?

리소스 신규 생성

요청 받은 리소스가 서버에 없다면 서버는 /members/100이라는 신규 리소스를 생성하고 데이터를 저장한다.

✔︎ 주의!

여기서 주의해야할 것이 있다. 분명 PUT은 리소스를 '완전히 대체'한다고 했다.
만약 서버에 /members/100 리소스가 이미 있을 때 클라이언트가 /members/100에 username은 없이 age: 50 담아서 보낸다고 하자. 결과는 어떻게 될까? age만 변경이 될까?

PUT은 리소스를 완전히 대체하기 때문에 기존 username 또한 사라지고 age: 50만 남는다.
즉, 리소스는 완전히 대체된다. 기존 리소스를 삭제하고 새로 생성하는 것이기 때문이다.

리소스를 부분 변경하고 싶다면 Patch를 사용하면 된다.

📌 PATCH

리소스 부분 변경

리소스를 부분 변경하고 싶을 때는 Patch를 사용하면 되는데 간혹 Patch를 지원하지 않을 수 있다. 이때는 POST를 사용하면 된다.

POST는 무적이다.

리소스 부분 변경

이전의 PUT에서와 같은 예제이다. PUT을 사용할 때는 서버의 /memebrs/100의 username도 삭제가 되었다. Patch를 사용하면 어떨까?

부분 변경 완료

PUT의 결과와는 다르게 부분 변경이 완료 되었다. 보내지 않은 데이터인 username은 그대로 살아있고 변경을 원한 age만 교체되었다.

📌 DELETE

리소스 제거

위처럼 DELETE를 포함하고 /members/100를 보내면 서버의 해당 리소스가 삭제된다.

⭐️ HTTP 메서드의 속성

안전(Safe Methods)
멱등(Idempotent Methods)
캐시가능(Cacheable Methods)

메서드 표

표를 보면 GET 요청에 BODY가 없다고 되어 있다. 분명 위에서는 GET 요청에 Body가 있을 수 있다고 했는데 왜일까?
왜냐하면 GET 요청에 Body는 있을 수 있지만 되는 곳도 있고 안되는 곳도 있기 때문에 실상 사용하지 않는다. 때문에 '아니오'라고 표시되어 있다.

📌 안전(Safe Methods)

호출해도 리소스를 변경하지 않는다.
- Q: 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면요?
- A: 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.

HTTP 메서드의 속성 중 '안전'은 호출해도 리소스를 변경하지 않는 것을 말한다.

GET같은 경우 안전할까?
물론이다. GET은 단순 조회이기 때문에 리소스를 변경하지 않는다. 따라서 안전하다.

그런데 POST, PUT, PATCH, DELETE는 당연히 안전하지 않다. 모두 리소스를 변경하기 때문이다. 위에서 제시한 표를 다시 보면 GET, HEAD 등 4개를 제외한 모든 메서드는 안전하지 않다고 나와있다.

📌 멱등(Idempotent Methods)

f(f(x)) = f(x)
한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
멱등 메서드
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
  
  PUT도 멱등이라니 왜일까?
  만약 파일을 업로드 했다고 치자. 그런 다음 다시 한 번 똑같은 파일을 업로드 했다.
  두 번의 업로드를 했는데 그 결과 파일이 다를까 같을까? 똑같은 파일을 업로드 했기에 당연히 같은 파일이다. 때문에 멱등이다. Delete 또한 같은 맥략으로 멱등이다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.

멱등이 왜 필요할까?

자동 복구 매커니즘

DELETE로 호출했는데 서버에서 응답이 없다고 하자. 사용자는 DELETE 요청이 됐는지 안됐는지 알 수가 없다. 그러면 클라이언트가 자동으로 다시 DELETE를 재시동한다. 하지만 아무런 문제가 없다. 왜일까?
Delete는 멱등이기 때문이다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다. 이렇기 때문에 멱등은 필요하다.

멱등 예외 예시