(모든 개발자를 위한 HTTP 웹 기본 지식) 4-(1)~(5) HTTP메서드

- HTTP API를 만들어보자

• 실무에 투입됐다고 생각해보자.
• 요구사항을 가지고 회원 정보 관리 API를 만들어보자
  • 회원 목록 조회
  • 회원 조회
  • 회원 등록
  • 회원 수정
  • 회원 삭제
• API URI설계
  • 회원 목록 조회 / read-member-list
  • 회원 조회 / read-member-by-id
  • 회원 등록 / create-member
  • 회원 수정 / update-member
  • 회원 삭제 / delete-member
• 위와 같이 설계하면 좋은 설계일까? 가장 중요한 것은 리소스 식별이다.
• 리소스의 의미는?
  • 회원을 등록하고 수정하고 조회하는게 리소스가 아님
  • 미네랄을 캐라 => 미네랄이 리소스
  • 회원이라는 개념 자체가 리소스
• 리소스를 어떻게 식별하는 게 좋을까
  • 회원을 등록하고 수정, 조회하는 건 모두 배제
  • 회원이라는 리소스만 식별하면 됨. 회원 리소스를 URI에 매핑
• 그래서 변화한 URI설계는?
  • 회원 목록 조회 /members
  • 회원 조회 /members/{id}
  • 회원 등록 /members/{id}
  • 회원 수정 /members/{id}
  • 회원 삭제 /members/{id}
  • 조회, 등록, 수정, 삭제를 어떻게 구분하지?
• 리소스와 행위를 분리하고 가장 중요한 건 리소스를 식별
  • URI는 리소스만 식별
  • 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원 / 행위 : 조회 등록 삭제 변경
  • 리소스는 명사, 행위는 동사
  • 이걸 GET, POST가 리소스의 행위를 분리하도록 해줌

-  GET, POST

• HTTP 메서드는 클라이언트가 서버에 요청을 할 때 기대하는 행동을 말함
• HTTP 메서드의 종류(주요 메서드)
  • GET : 리소스 조회
  • POST : 요청 데이터 처리, 주로 등록에 사용
  • PUT : 리소스를 대체, 해당 리소스가 없으면 생성
  • PATCH : 리소스 부분 변경
  • DELETE : 리소스 삭제
  • 그외
    • HEAD : GET과 동일하지만 메시지 부분을 제외하고 상태줄과 헤더만 반환
    • OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명
    • CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
    • TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
  • GET
    • 리소스 조회
    • 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
    • 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장 x
    • 과정 
      • 리소스 조회 1 (메시지 전달) : 클라이언트가 서버에 요청
      • 리소스 조회2(서버 도착) : 서버가 GET메시지를 받고 요청 파악 후 반환할 응답 메시지 만듦
      • 리소스 조회3(응답 데이터) :응답 데이터를 클라이언트에게 보냄. 응답데이터는 보낸 데이터의 타입, 길이 등의 정보도 함께 전송
  • POST
    • 요청 데이터 처리
    • 메시지 바디를 통해 서버로 요청 데이터 전달
    • 서버는 요청 데이터를 처리
      • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
    • 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
    • 과정
      • 리소스 등록1(메시지 전달) : 예를 들어 '/members'가 오면 어떤 동작을 할지 미리 약속되어 있음.  클라이언트가 메시지 전달
      • 리소스 등록2(신규 리소스 생성) : 서버가 관련된 기능 수행, 데이터베이스에 저장하고 신규 리소스 식별자 생성
      • 리소스 등록3(응답 데이터) : 응답 데이터 전송하고 자원이 생성된 경로도 보내줌. 등록된 자원(데이터)도 보내줌
    • 요청데이터를 어떻게 처리한다는 뜻일까 ? 의미가 많은 메서드!!
      • 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청
      • 예
        • HTML양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
        • 게시판, 뉴스 그룹, 메일링 리스트, 블로그, 유사한 기사그룹에 메시지 게시
    • 새 리소스 생성(등록) : 서버가 아직 식별하지 않은 새 리소스 생성
    • 요청 데이터 처리
      • 단순히 데이터를 생성하거나 변경하는 것을 넘어서 프로세스 처리하는 경우
      • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
      • ex) POST/orders/{orderId}/start-delivery -  ( 컨트롤 uri) 
    • 다른 메서드로 처리하기 애매한 경우에도 사용
      • JSON으로 조회 데이터를 넘겨야하는데 GET메서드 사용하기 어려운 경우
      • 애매할 때 사용

- PUT, PATCH, DELETE

• PUT
  
  • 리소스가 있으면 대체하고 없으면 생성.
  • 클라이언트가 리소스를 식별
    • 클라이언트가 리소스 위치를 알고 URI지정
    • POST와의 차이점
  • 리소스가 있는 경우 기존에 그 리소스가 있었다면 대체해버림
  • 리소스가 없는 경우는 신규 리소스가 생성됨
  • 주의 ! 리소스를 완전히 대체 함. 예를 들어 username & age 중 age 만 대체하고 싶어도 모든걸 대체해버림.(username 날아가버림). 리소스를 수정하는게 아니라는 것! 
  • 리소스를 부분변경 하고 싶다면 PATCH를 사용하자!
• PATCH 
  • 리소스 부분 변경 가능
• DELETE
  • 리소스 제거

 

-  HTTP 메서드의 속성

• 안전(Safe Methods)
  • 호출해도 리소스를 변경하지 않음
  • GET, HEAD, OPTIONS, TRACE
  • 계속 호출해서 로그 같은게 쌓여 장애가 발생하면? 이런 부분까지 고려하지 않고 해당 리소스의 변경 여부만 고려
• 멱등
  • f(f(x)) = f(x) 
  • 한 번 호출하든, 두번 호출하든 아무리 몇 번을 호출하든 결과가 똑같음
  • GET : 몇 번을 조회해도 같은 결과 조회
  • PUT : 똑같은 파일을 업로드, 또 똑같은 파일을 계속 업로드 => 기존 파일을 날리고 덮어씌우기 때문에 결과 동일
  • DELETE : 결과 삭제, 몇번을 삭제해도 한 번 삭제했으니 그 결과가 같음
  • POST : 멱등이 아님 !!  두번 호출하면 같은 결제 중복 발생 가능
  • 활용
    • 자동 복구 메커니즘
    • 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는지에 대한 판단 근거가 됨
  • 재요청 중간에 다른 곳에서 리소스를 변경한다면?? 멱등은 외부 요인으로 리소스가 변경되는 것까지 고려하지 않음
• 캐시 가능
  • 응답 결과 리소스를 캐시해서 사용해도 되는가?
  • GET, HEAD, POST, PATCH 캐시 가능
  • 실제로 GET, HEAD 정도만 캐시로 사용
    • POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데 구현이 쉽지 않음