[HTTP] 4.HTTP 메서드

[HTTP] 4.HTTP 메서드

 

1. HTTP API 만들기

<회원 정보 관리 API 만들기>

 

[요구사항]

- 회원 목록 조회

- 회원 조회

- 회원 등록

- 회원 수정

- 회원 삭제

 

[URI]

- 회원 목록 조회 /read-member-list

- 회원 조회 /read-member-by-id

- 회원 등록 /create-member

- 회원 수정 /update-member

- 회원 삭제 /delete-member

 

이게 좋은 URI 설계일까?
-> 리소스를 기준으로 설계해야함! (중요) -> 리소스 식별

 

API URI 고민

- 리소스의 의미

   > 회원을 등록하고 수정하고 조회하는 것이 리소스가 아니다!

   > ex) 미네랄을 캐라 -> 미네랄이 리소스

   > 회원이라는 개념 자체가 바로 리소스

 

- 리소스를 어떻게 식별하는게 좋을까?
   > 회원을 등록하고 수정하고 조회하는 것을 모두 배제

   > 회원이라는 리소스만 식별하면 됨 -> 회원 리소스를 URI에 맵핑

/members/{id}

 

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

- URI는 리소스만 식별!

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

   > 리소스  :  회원

   > 행위     :  조회/등록/삭제/변경

- 리소스는 명사, 행위는 동사 (미네랄을 캐라)

- 행위(메서드)는 어떻게 구분? -> HTTP 메서드가 해줌

---

2. HTTP 메서드 - GET, POST

HTTP 메서드

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

기타 메서드

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

 

1) GET

- 리소스 조회

- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달

- 메시지 바디를 사용해서 데이터 전달할 수 있지만, 지원하지 않는 곳이 많아 권장 X

- 리소스 조회1 : 메시지 전달

- 리소스 조회2 : 서버 도착

메시지 전달 및 서버에서 데이터 찾기

- 리소스 조회3 : 응답 데이터

데이터 찾은 후 응답

2) POST

- 요청 데이터 처리

- 메시지 바디를 통해 서버로 요청 데이터 전달

- 서버는 요청 데이터를 처리

   메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행

- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

- 리소스 등록1 - 메시지 전달

- 리소스 등록2 - 신규 리소스 생성

- 리소스 등록3 - 응답 데이터

- 신규로 자원 생성되면 HTTP/1.1 201 Created 라고 보냄 (200으로 보내도됨)

- 201로 보낼때 Location 보내줌 (신규 생성된 자원의 path 보내주고, 등록된 자원 데이터도 보내줌)

 

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

- 스펙 : POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청 - POST는 다음과 같은 기능에 사용됨 1) HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공     ex) HTML FORM에 입력한 정보로 회원가입, 주문 등에 사용 2) 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시     ex) 게시판 글쓰기, 댓글 달기 3) 서버가 아직 식별하지 않은 새 리소스 생성      ex) 신규 주문 생성 4) 기존 자원에 데이터 추가      ex) 한 문서 끝에 내용 추가

 

핵심)
이 리소스 URI에(/members) POST요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 -> 정해진 것이 없음 

 

정리)

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

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

2) 요청 데이터 처리

   - 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야하는 경우

      ex) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우

   - POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음

      ex) POST/orders/(orderId)/start-delivery (컨트롤 URI)

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

      ex) JSON으로 조회 데이터를 넘겨야하는데, GET 메서드를 사용하기 어려운 경우

   - 애매하면 POST

---

3. HTTP 메서드 - PUT, PATCH, DELETE

1) PUT

리소스를 대체

- 리소스가 있으면 대체

- 리소스가 없으면 생성

- 쉽게 이야기하면 덮어버리는 것

 

클라이언트가 리소스를 식별 (중요)

- 클라이언트가 리소스 위치를 알고 URI 지정

- POST와 차이점

  POST - 클라이언트가 /members 어디에 집어넣는지 모름

  PUT    - 클라이언트가 /members 100에 집어넣는다고 명시

 

- 리소스가 있는 경우

- 클라이언트가 100에 넣는다고 지정

- 서버에 100이 이미 있다면 리소스 대체

 

주의) 리소스를 완전히 대체한다!!!

(특정 리소스 수정/변경이 아님)

 

2) PATCH

- 리소스 부분 변경

- age만 50으로 변경 가능!!

- PATCH 지원 안하는 경우 -> POST 쓰면됨!

 

3) DELETE

- 리소스 제거

- members 100번 지우겠다 -> 리소스 제거

 

---

4. HTTP 메서드의 속성

1) 안전 (Safe Methods)

- 호출해도 리소스를 변경하지 않음

- 그래도 계속 호출해서 로그 쌓여서 장애 발생 ? -> 안전은 해당 리소스만 고려

 

2) 멱등 (Idempotent Methods)

- f(f(x)) = f(x)

- 한 번 호출하든, 100번 호출하든 결과가 똑같다

- 멱등 메서드

GET        : 한 번 조회하든, 두 번 조회하든 같은 결과가 조회됨

PUT        : 결과를 대체, 따라서 같은 요청을 여러번 해도 최종 결과는 같음
DELETE  : 결과를 삭제, 같은 요청을 여러번 해도 삭제된 결과는 같음
POST     : 멱등이 아니다! 두 번 호출하면 같은 결제 중복 발생 가능

 

- 활용

> 자동 복구 메커니즘

> 서버가 TIMEOUT 등으로 정상 응답 못줄때 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거

 

Q : 재요청 중간에 다른 곳에서 리소스를 변경해버리면?  (GET / PUT / GET)

A : 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않음

 

3) 캐시가능 (Cacheable Methods)

- 응답 결과 리소스를 캐시해서 사용해도 되는가?

- GET / HEAD / POST / PATCH 캐시 가능

- 실제로 GET / HEAD 정도만 캐시로 사용

- POST / PATCH 캐시 키로 고려해야하는데 구현 어려움