[네트워크] 4. HTTP 메서드

1️⃣ HTTP API를 만들어보자

요구사항: 회원정보 관리 API를 만들어라
- 회원 목록 조회, 회원 조회, 회원 등록, 회원 수정, 회원 삭제

가장 중요한건 리소스 식별

 

API URI 고민

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

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

 

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

회원 목록 조회	/members
회원 조회	/members/{id}
회원 등록	/members/{id}
회원 수정	/members/{id}
회원 삭제	/members/{id}

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

 

그런데, 조회 등록 수정 삭제를 어떻게 구분하지?

 

리소스와 행위를 분리

가장 중요한 것은 리소스를 식별하는 데만 사용해야한다. 즉, URI는 리소스만 식별해준다.

리소스와 해당 리소스를 대상으로 하는 행위를 분리한다.

• 리소스: 회원
• 행위: 조회, 등록, 수정, 삭제

리소스는 명사, 행위는 동사 -> 행위는 HTTP 메서드로 구분해준다.

 

---

 

2️⃣ HTTP 메서드 - GET, POST

HTTP 메서드 종류

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

HTTP 기타 메서드

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

GET: 리소스 조회

• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음

[네트워크] #4-2 HTTP기본 - 비연결성 / HTTP 메시지

클라이언트에서 100번째 member를 조회하는 GET 요청을 보냄

이 요청을 받은 서버는 메시지에 담긴 내용을 바탕으로 100번째 member를 서버에서 조회하고 응답데이터를 생성(여기서는 json형식으로 생성)해 클라이언트에게 보낸다.

서버에서 HTTP 응답 메시지를 클라이언트로 전달한다.

POST: 요청 데이터 처리(등록)

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

클라이언트에서 username이 "young"이고 나이가 20인 members 데이터를 POST를 통해 서버로 보낸다

서버에서는 /members/100에 받은 데이터를 저장하고, 클라이언트에 HTTP 응답 메시지를 전달한다.

여기서 100은 서버에서 데이터를 생성할 location을 임의로 100으로 지정해준 것이다.

위 이미지에서는 201로 전달했기 때문에 Location 즉, 데이터가 저장된 위치(/members/100) 정보를 클라이언트 HTTP 헤더에 포함해 전달한다.

POST는 그럼 등록(저장)만 하는 걸까?

POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다.

• HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
  • ex) HTML 폼에 입력한 정보로 회원가입, 주문 등을 할 때 사용
• 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 곳들에 글을 게시할 때
  • ex) 게시판 글쓰기, 댓글 달기
• 서버가 아직 식별하지 않은 새 리소스 생성
  • ex) 신규 주문 생성
• 기존 자원에 데이터 추가
  • ex) 한 문서 끝에 내용 추가하기

즉, 이 리소스 URI에 POST 요청이 오면, 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. 

정해진 것이 없음!

POST를 사용할 때

1. 새 리소스 생성(등록)
   
   • 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
   • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
   • ex) 주문에서 결제 완료 > 배달 시작 > 배달 완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
   • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음. 그래도 서버에서 큰 변화가 일어나는 건 POST를 사용해야함!
   • ex) POST /orders/{orderId}/start-delivery (컨트롤URI)
     • 기본적인건 리소스 URI로 설계를 하되, 추가로 설계해야할 부분들은 컨트롤URL를 사용해 추가하기도 한다.
3. 다른 메서드로 처리하기 애매한 경우
   • ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우(GET message body를 지원하지 않는 경우)
   • 애매하면 POST 사용(그래도 조회는 GET을 사용하는게 좋다 !!)

 

---

 

3️⃣ HTTP 메서드 - PUT, PATCH, DELETE

PUT: 리소스를 완전히 대체

• 리소스가 있으면 대체
• 리소스가 없으면 생성
• 쉽게 이야기해서 덮어버림

PUT /members/100 HTTP/1.1
Content-Type: application/json

{
  "name": "hello",
  "email": "xxxxxx@google.com",
  "phone": "010-1234-5678"
}

클라이언트가 리소스를 식별한다!

• 클라이언트가 리소스 위치를 알고 URI 지정
  • 위 HTTP 요청 형식에서 볼 수 있듯이 100번째 members에 데이터를 넣을거라고 URI에 지정해뒀음
• POST와의 차이점

100번째 members가 존재하기 때문에 새로 요청된 데이터로 덮어씌워진다. 기존 데이터가 없으면 새로 요청된 데이터가 저장된다 !

엥 근데 username 없이 age 데이터만 대체하고 싶은데 ..?

이렇게 필드를 하나만 지정해서 PUT요청을 보내게 되면, 

이렇게 username 필드가 사라지고 새로 전송한 age:50으로 덮어씌우게 된다.

 

엥 !!!!!! 나는 age만 수정하고 싶었다고 !!!!!!

 

PATCH: 리소스 부분 변경

기존에 PUT밖에 없었지만 PATCH의 혜성같은 등장

부분 수정하고 싶다면 PUT이 아니라 PATCH를 사용해야한다.

클라이언트에서 age만 바꾸고 싶어서 age필드만 PATCH로 보냈다.

age 필드만 부분적으로 변경할 수 있음!

근데 가끔 HTTP에서 PATCH를 지원하지 않는 곳이 있다. 이 경우, 어떻게 해야할까?

POST를 사용한다 ! POST 는 신이야.

DELETE: 리소스 제거

지우고 싶은 members의 100번째 데이터를 URI에 지정해서 DELETE로 보내면, 해당 리소스를 삭제한다.

 

---

4️⃣ HTTP 메서드의 속성

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

안전(Safe)

• 여러번 호출해도 리소스를 변경하지 않는다. (GET)

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

 

멱등(Idempotent)

• 한 번 호출하든 두 번 호출하든, 100번 호출하든 결과가 똑같다.
• f(f(x)) = f(x)
• GET, PUT, DELETE는 멱등하고, POST, PATCH는 멱등하지 않다.

멱등 메서드

• GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
• PUT: 결과를 대체한다. 따라서 같은 요청을 여러 번 해도 최종 결과는 같다.
• DELETE: 결과를 삭제한다. 같은 요청을 여러 번 해도 삭제된 결과는 똑같다.
• POST: 멱등이 아님! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.

멱등을 활용하는 곳

• 자동 복구 메커니즘
• 서버가 TIMEOUT등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단근거 
  • ex) DELETE 요청을 보냈는데 성공했는지, 안했는지 정상 응답을 받지 못해 확인이 안된다. 이 경우 일정 시간이 흐른 후, 클라이언트에서 자동으로 같은 DELETE를 요청해도 된다. WHY? DELETE는 멱등하니까!!

Q) 재요청 중간에 다른 곳에서 리소스를 변경해버리면?
- 사용자1: GET > username:A, age:20
- 사용자2: PUT > username:A, age:30
- 사용자1: GET > username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회

A) 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다. 내가 동일한 요청을 N번 보냈을 때 결과가 동일한가만 판단한다. 동일한 사용자가 똑같은 요청을 여러번 하는 것에 대해 고려한다.

 

캐시가능(Cacheable)

• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• GET, HEAD, POST, PATCH 캐시가능
• 실제로는 GET, HEAD 정도만 캐시로 사용(실무에서는 거의 GET만 캐시로 사용한다고 보면 된다.)
  • POST, PATCH는 본문 내용까지 캐시키로 고려해야하는데, 구현이 쉽지 않음