4강 HTTP 메서드

4.1 HTTP API 설계해보자

요구사항

• 회원정보 관리 API
• 목록조회, 조회, 등록, 수정, 삭제

API URI 설계

• 설계에서 리소스 식별이 가장 중요함
• 리소스의 의미는 무엇인가?
  • 회원이라는 개념 자체가 리소스(명사)
  • 회원을 등록하고 수정하고 조회하는 모든것을 배제한다.
  • 회원이라는 리소스만 식별하면된다
• 회원 목록조회 /members
• 회원 조회 /members/:id
• 회원 등록
• 회원 수정
• 회원 삭제

(구조상 상위를 컬렉션으로 보고 복수형을 사용한다)

리소스와 행위를 분리해야한다

• 리소스 : 회원(명사)
• 행위 : 조회, 등록, 삭제, 변경(동사)
• URI는 리소스를 식별하는데에만 사용해야 한다.

4.2 HTTP 메서드 - GET, POST

HTTP 메서드 종류

• GET
• POST
• PUT
• PATCH
• DELETE
• HEAD
• OPTIONS
• CONNECT
• TRACE

GET

• 리소스 조회하는 것
• query를 통해 서버에 데이터 전달
• 메시지 바디 이용도 가능하지만 권장되지 않음

POST

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

POST의 상세 의미

• 대상 리소스가 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청한다.
• 활용 예시
  • HTML FROM
  • 게시판 글쓰기
  • 새 리소스 생성 (신규 주문, 회원 생성)
  • 기존 자원의 끝에 데디어 추가
• 핵심은 리소스마다 POST 요청을 어떻게 처리할지 각각 정해야 한다.

POST 정리

• 새 리소스 생성
• 요청 데이터 처리
  • 단순한 생성, 변경을 넘어서 데이터 프로세스가 변경되는 경우
  • POST의 결과로 신규 리소스 생성이 안될수도 있다.
  • 서버에서 큰 변화가 일어난 경우 POST 활용한다
  • POST /orders/{orderid}/start-delivery (컨트롤 URI, 실무에서 동사를 활용하기도 한다)
• 다른 메서드로 처리하기 애매한 경우
  • GET 메서드로 처리하기 곤란한 경우
  • JSON으로 조회 데이터를 넘기는데 GET 메서드를 사용하기 어려운 경우 (메시지 바디에 JSON을 포함시켜야되는데 일반적인 서버에서 GET요청에서 바디를 활용하지 못하므로)
• POST는 모든 것을 할수 있지만, 서버간의 약속때문에 GET을 활용할 수 있으면 GET을 쓸 수 있다.

4.3 HTTP 메서드 - PUT, PATCH, DELETE

PUT

• 리소스를 대체
  • 있으면 생성하고 없으면 완전히 덮어씀
• 중요! 클라이언트가 리소스를 식별함

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

    POST /members HTTP/1.1 -> POST는 위치 미지정
    PUT /members/100 HTTP/1.1 -> PUT은 위치 지정

• PUT에서 지정하지 않은 필드는 다 날라간다. addition이 아니라 기존리소스를 완전히 삭제하고 새로 쓰는 것

PATCH

• 리소스를 부분변경하기 위해 활용하는 메서드
• PATCH 에서는 지정한 필드만 부분변경, 나머지는 그대로 둔다.
• PATCH가 지원되지 않는 서버도 있음
  • 그럴때는 무적의 POST 활용

DELETE

• 리소스 제거

4.4 HTTP 메서드의 속성

안전(Safe)

• 호출해도 리소스를 변경하지 않는다. (GET은 안전, POST, PUT, PATCH, DELETE 는 불안전)
• 안전하다의 고려 대상은 해당 리소스만으로 한정한다.

멱등(Idempotent)

• 한번 호출하던, 두번 호출하던, 100번 호출하던 동일한 결과
• 외부 요인으로 리소스가 바뀐 것은 고려하지 않는다.
• 멱등 메서드
  • GET
  • PUT : 결과를 대체하므로 같은 요청을해도 최종 결과는 같음
  • DELETE
• POST : 멱등하지 않음, 두번 호출하면 같은 결제가 두번 발생 가능함
• 멱등성은 자동 복구 매커니즘이 적용 가능한지에 중요
  • 멱등한 메서드는 자동복구 가능하다.
  • 서버가 TimeOut등으로 정상 응답을 못주었을때, 멱등한 메서드는 자동으로 재호출하게 설계하면된다.

캐시가능

• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• GET HEAD POST PATCH는 캐시 가능하지만
• 실제로 GET, HEAD 만 캐시로 사용