인프런의 모든 개발자를 위한 HTTP 웹 기본 지식을 듣고 정리한 내용입니다.

🪧HTTP API를 만들어보자

요구사항 (회원 정보 관리 API)
  • 회원 목록 조회
  • 회원 조회
  • 회원 등록
  • 회원 수정
  • 회원 삭제

⇒ 위의 요구사항을 바탕으로 API를 만드려면 어떻게 해야할까❔

API URI 설계
  • 회원 목록 조회 /read-member-list
  • 회원 조회 /read-member-by-id
  • 회원 등록 /create-list
  • 회원 수정 /update-list
  • 회원 삭제 /delete-list

⇒ 단순하게 이와 같은 설계를 할 수 있다. 하지만 위의 설계는 좋은 URI 설계가 아니다.
URI 설계에서 가장 중요한 것은 리소스의 식별 이다. 여기서 리소스란 무엇을 의미할까❔

리소스의 의미
  • 회원을 등록 하고 수정 하고 조회 하는 행위를 리소스라고 하지 않는다.
  • 회원 이라는 개념 자체가 리소스다.

⇒ 그렇다면 아까 위의 설계를 바꿔볼 수 있다.

API URI 설계
  • 회원 목록 조회 /members
  • 회원 조회 /members/{id}🤷
  • 회원 등록 /members/{id}🤷
  • 회원 수정 /members/{id}🤷
  • 회원 삭제 /members/{id}🤷

⇒ 이 경우에 조회, 등록, 수정, 삭제의 URI가 모두 같아 구분하기 어렵다.
이를 위해서 HTTP 메서드를 이용한다.

리소스와 행위를 분리
  • URI는 리소스만 식별한다.
  • 리소스와 해당 리소스를 대상으로 하는 행위(메서드)를 구분한다.
    • 리소스: 회원
    • 행위(메서드): 조회, 등록, 수정, 삭제
  • 리소스는 명사, 행위(메서드)는 동사
  • 행위는 HTTP 메서드를 통해서 구분한다.

🪧HTTP 메서드의 종류

주요 메서드
  • GET: 리소스 조회
  • POST: 요청 데이터 처리, 주로 등록에 사용
  • PUT: 리소스를 대체, 해당 리소스가 없으면 생성
  • PATCH: 리소스 부분 변경
  • DELETE: 리소스 삭제
기타 메서드
  • HEAD: GET과 동일하지만 메시지 부분을 제외하고 상태 줄과 헤더만 반환
  • OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
  • CONNECT: 대상 자원으로 식별되는 서버에 대한 터널 설정
  • TRACE: 대상 리소스에 대한 겨오를 따라 메시지 루프백 테스트 수행

🏷️GET

  GET /search?q=hello&hl=ko HTTP/1.1
  Host: www.google.com
  • 리소스 조회에 사용된다.
  • 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해 전달한다.
  • 메시지 바디를 사용할 수는 있지만 지원하지 않는 곳이 더 많아 권장하지 않는다.



리소스 조회 과정
  1. 클라이언트에서 /members/100 으로 100번 유저를 조회해서 정보를 달라고 GET 요청을 서버에 보낸다.
  2. 서버에서는 받은 메시지를 분석해 유저정보를 조회한 뒤 결과를 만들고 응답한다.

🏷️POST

POST /members HTTP/1.1
Content-Type: application/json

  {
      "username": "hello",
    "age": 20
  }
  • 요청 데이터를 처리하는데 사용된다.
  • 메시지 바디를 통해 서버로 요청 데이터 전달한다.
  • 서버는 요청 데이터를 처리한다.
  • 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용된다.



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

⇒ 이 리소스 URI에 POST요청이 오면 요청데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다.(정해진 것이 없다.)

🔖정리
  1. 새 리소스 생성(등록)
    • 서버가 아직 식별하지 않은 새 리소스 생성
  2. 요청 데이터 처리
    • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
    • 주문에서 결제 완료 → 배달 시작 → 배달 완료 처럼 단순히 값 변경을 넘어선 프로세스의 상태가 변경되는 경우
    • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음.
    • ex) POST /orders/{orderId}/start-delivery (컨트롤 URI)
      리소스단위로 설계하기 힘든 경우가 있는데 위의 예처럼 행위를 포함한 URI를 설계할 수 있다.
  3. 다른 메서드로 처리하기 애매한 경우
    • ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
    • 애매하면 POST

🏷️PUT

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

  {
      "username": "hello",
    "age": 20
  }
  • 리소스를 대체하는데 사용된다.(덮어버린다.)
    • 리소스가 있으면 대체
    • 리소스가 없으면 생성
  • 클라이언트가 리소스를 식별
    • 클라이언트가 리소스 위치를 알고 URI 지정
    • POST와 PUT의 차이점이다.

⇒ PUT을 이용하면 내용이 덮어 쓰이기 때문에 부분적으로 변경(수정)할 수 없다.
수정(부분적 변경)이 하고 싶다면 PATCH메서드를 이용한다.


🏷️PATCH

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

  {
      "age": 50
  }
  • 리소스를 부분 변경하는데 사용된다.


🏷️DELETE

  DELETE /members/100 HTTP/1.1
  HOST: localhost:8080
  • 리소스를 제거하는데 사용된다.


🪧HTTP 메서드의 속성

🛡️안전(Safe Methods)

  • 호출해도 리소스가 변경되지 않는다.
    • GET 같은 경우에 조회만 하기 때문에 리소스를 변경하지 않아서 안전하다.
    • POST, PUT, DELETE, PATCH 같은 경우 리소스를 변경하기에 안전하지 않다.
  • 안전의 범위는 해당 리소스만 고려하기에, 외적인 요소까지는 고려하지 않는다.
    ex) 리소스 호출시마다 로그가 남는다고 하더라도 리소스에 대한 영향은 아니기 때문에 고려❌

🖨️멱등(Idempotetn Methods)

f(f(...f(x)) = f(x)
  • 메서드를 몇번 호출하더라도 결과가 동일해야 한다.
  • 멱등 메서드
    • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
    • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
    • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
    • POST: 멱등이 아니다(❌). 두 번 호출하면 에러가 발생할 수 있다.
      ex) 주문을 두 번 호출하면 같은 결제가 중복되서 발생할 수 있다.
  • 활용방법
    • 자동 복구 메커니즘
    • 서버가 TIMEOUT 등으로 정상 응답을 하지 못했을 때 클라이언트에서 같은 요청을 해도 되는지에 대한 판단 근거가 된다.
  • 멱등은 외부 요인으로 인해 리소스가 변경되는 것은 고려하지 않는다. 자신이 호출하는 것에 한정한다.
    ⇒ 회원정보를 GET요청으로 조회할 때, 그 사이에 다른 클라이언트의 PUT, POST 요청으로 회원정보가 변경되서 조회 결과가 달라지는 것은 고려하지 않는다.

🙆캐시가능(Cacheable Methods)

  • 응답 결과를 캐시에서 사용할 수 있을까?
  • GET, HEAD, POST, PATCH 는 캐시가 가능하다.
  • 실제로는 GET, HEAD 정도만 캐시로 사용 가능하다.
    ⇒ POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.

'CS > Network' 카테고리의 다른 글

[HTTP] 🌐HTTP 기본  (0) 2022.04.06
[HTTP] 🌐URI와 웹 브라우저 요청 흐름  (0) 2022.04.04
[HTTP] 🌐인터넷 네트워크  (0) 2022.04.01