HTTP 메서드

김영한님의 강의를 통해 배운 내용을 기록
강의 링크

API URI 설계

---

URI는 리소스만 식별할 것 !

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

리소스와 행위를 분리

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

리소스만 식별하면 HTTP 메서드가 행위를 대신 해줌

GET, POST

---

주요 메서드

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

기타 메서드

• HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)

GET

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

// 요청 데이터
GET /members/100 HTTP/1.1
Host: localhost:8080

// 서버도착 
// 서버에서 메시지를 확인하고 알맞은 데이터를 준비함

// 응답 데이터
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 34 

{
	"username":"young",
    "age":20
}

POST

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

// 리소스 등록1 - 메시지 전달 
POST /members HTTP/1.1
Content-Type: application/json

{
 "username":"young",
 "age":20
}

// 서버에선 신규 리소스 생성 
/members/100 신규 리소스 식별자 생성
{
  "username":"young",
  "age":20
}

// 응답 데이터
HTTP/1.1 201 Created
Content-Type:application/json
COntent-Length:34 
Location:/members/100 <- Created인 경우 생성된 경로를 포함시킴

{
  "username":"young",
  "age":20
}

POST는 어떤 경우에 사용?

• HTML FROM에 입력한 정보로 회원 가입, 주문 등에서 사용
• 게시판 글쓰기, 댓글 달기
• 신규 주문 생성
• 한 문서 끝에 내용 추가하기
• 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야한다

1. 새 리소스 생성(등록)

• 서버가 아직 식별하지 않은 새 리소스 생성

2. 요청 데이터 처리

• 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
• 예) 주문에서 결제 완료 => 배달 시작 => 배달 완료 처럼 단순히 값 변경을 넘어 이후 프로세스의 상태가 변경되는 경우
• POST의 결과로 새로운 리소스가 생성되지 않을
  수도 있다.
• 예) POST /orders/{drderId}/start-delivery(컨트롤 URI) => URI는 리소스만 식별하기로 했지만 실무에선 부득이하게 행위를 구분해야 하는 경우가 있다.

3. 다른 메서드로 처리하기 애매한 경우

• 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우 (GET은 body를 넘기지 않기 때문에)
• 애매하면 POST
• 다만, 되도록이면 조회할 땐 GET을 쓸 것. 왜냐하면 GET 요청이면 캐싱을 하도록 서버끼리 약속이 되어있기 때문에

PUT

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 덮어버리는 것(완전히 대체)
• 클라이언트가 리소스를 식별!
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점

// 요청 전달 
PUT /members/100 HTTP/1.1
Content-Type: application/json 

{
  "username":"hello"
}


// 만약 서버에 아래와 같은 데이터가 있다면 age는 삭제, username은 helLo로 대체된다.
// 요청 받기 전
{
  "username":"kimcoding",
  "age":20
}

// 요청 받은 후 
{
  "username":"hello"
}

• PUT은 리소스를 완전히 대체하기 때문에 수정하는 메서드로 보기 어렵다. 수정을 위한 메서드로는 PATCH가 존재한다!

PATCH

• 리소스 부분 변경

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

{
  "age":50
}

// 서버에 아래와 같은 데이터가 존재할 경우
// 수정 전 
{
  "username":"young",
  "age":20
}

// 수정 후 
{
  "username":"young",
  "age":50
}

DELETE

• 리소스 제거

DELETE /members/100 HTTP/1.1
Host:localhost:8080

HTTP 메서드의 속성

---

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

1.안전

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

2.멱등

• f(f(x)) = f(x)
• 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
  • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
  • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
  • POST: 멱등이 아님! 결제 요청 같은 경우 중복 결제가 발생한다.
• 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
• 활용
  • 자동 복구 메커니즘에 활용할 수 있다.
    • DELETE 요청을 보냈을 때 서버에서 응답이 없는 경우 => DELETE 요청은 Idempotent Method이므로 중복해서 DELETE 요청을 보내도 된다.

3.캐시가능

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