[모든 개발자를 위한 HTTP 웹 기본 지식] HTTP 메서드

요구사항

• 회원 정보 관리 API를 만들어라.
  • 회원 목록 조회
  • 회원 조회
  • 회원 등록
  • 회원 수정
  • 회원 삭제

 

API URI(Uniform Resource Identifier) 설계 예시 - 1

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

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

• 회원 등록 /create-member

• 회원 수정 /update-member

• 회원 삭제 /delete-member

 

API URI(Uniform Resource Identifier) 고민

• 위의 API URI(Uniform Resource Identifier) 설계 예시 - 1 에서는 URI에 리소스가 여러 단어와 연결되어 식별이 어렵다.

• API 설계에서 가장 중요한 것은 리소스 식별

• 리소스의 의미는 뭘까?
  • 회원을 등록하고 수정하고 조회하는게 리소스가 아니다!
  • 예) 미네랄을 캐라 -> 미네랄이 리소스
  • 회원이라는 개념 자체가 바로 리소스다.

• 리소스를 어떻게 식별하는게 좋을까?
  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑

 

API URI(Uniform Resource Identifier) 설계 예시 - 2 (리소스 식별, URI 계층 구조 활용)

• 회원 목록 조회 /members

• 회원 조회 /members/{id}

• 회원 등록 /members/{id}

• 회원 수정 /members/{id}

• 회원 삭제 /members/{id}

• 참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

 

• 회원 조회 /members/{id}, 회원 등록 /members/{id}, 회원 수정 /members/{id}, 회원 삭제 /members/{id} URI를 구분할 수 있는 방법
  • 리소스와 행위을 분리한다. 가장 중요한 것은 리소스를 식별하는 것
  • URI는 리소스만 식별가능 하도록 구성한다.
  • 리소스와 해당 리소스를 대상으로 하는 행위을 분리하여 각 동작을 구분할 수 있다.
    • 리소스: 회원
    • 행위: 조회, 등록, 삭제, 변경
  • 리소스는 명사, 행위는 동사 (미네랄을 캐라)
  • 행위(메서드)는 어떻게 구분?

 

HTTP 메서드 종류

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

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

 

HTTP 메서드 - GET

• 리소스 조회

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

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

• 조회할 때 POST도 사용할 수 있지만 GET을 사용하는 것이 유리하다.
  • 서버끼리 GET으로 오면 캐싱을 하겠다는 약속이 존재한다. POST로 오면 이러한 처리가 어렵다.

• 리소스 조회 - 메시지 전달

• 리소스 조회 - 서버 도착

• 리소스 조회 - 서버에서 응답 메시지 만들어서 클라이언트에게 전달

 

HTTP 메서드 - POST

• 요청 데이터 처리

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

• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.

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

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

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

• 리소스 등록 - 서버에서 응답 메시지 만들어서 클라이언트에게 전달

  

  • 신규로 자원이 생성되면 201 Created를 보통 사용한다. Location은 자원이 신규로 생성된 URI 경로를 의미한다.
    
    
    
• POST 요청 데이터를 어떻게 처리한다는 뜻일까? 예시
  • 스펙: POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청합니다.
  • 예를 들어 POST는 다음과 같은 기능에 사용됩니다.
    • HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
      • 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
    • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
      • 예) 게시판 글쓰기, 댓글 달기
    • 서버가 아직 식별하지 않은 새 리소스 생성
      • 예) 신규 주문 생성
    • 기존 자원에 데이터 추가
      • 예) 한 문서 끝에 내용 추가하기
  • 정리: 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. (따로 정해진 것이 없다.)

 

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

 

HTTP 메서드 - PUT, PATCH, DELETE

• PUT 특징

  

  • 리소스가 있으면 대체한다.(덮어쓰기)
    • /members/100 이 존재하면 기존에 것이 사라지고 덮어쓴다.
  • 리소스가 없으면 생성
    • /members/100 이 없으면 새로 생성한다.
  • 클라이언트가 리소스를 식별한다.
    • 클라이언트가 리소스의 구체적인 전체 경로를 알고 URI 지정한다.(POST와의 큰 차이점)
    • POST에서는 100번에 만들어 질지 200번에 만들어 질지 몰라서 /members 로 요청하고 메시지 바디를 통해 데이터를 전달하면 서버가 만들어진 리소스 경로(/members/200, ...)를 알려준다.

 

• PUT - 리소스가 있는 경우

 

• 만약 나이만 50으로 변경하려고 해당 데이터를 PUT으로 전달하는 경우, 기존 데이터가 완전히 대체되어 이름 데이터가 삭제된다.

 

 

• PUT - 리소스가 없는 경우

---

• PATCH 특징
  • PUT은 기존 데이터를 일부 수정하는 것이 어렵다.
  • 리소스 부분(일부)을 변경한다.
  • PATCH를 지원하지 않는 서버에서는 대신에 POST를 사용할 수 있다.
  • 멱등하지 않다.
    • PATCH는 리소스의 특정 부분을 변경하는데, 이 변경 방식이 멱등이어도 되고, 멱등이 아니어도 된다.
  • PATCH - 리소스 부분 변경

  

  

---

DELETE 특징

• 리소스 제거

• 상태코드는 대부분 200을 사용하고 상황에 따라 204를 사용한다.

• DELETE - 리소스 제거

HTTP 메서드의 속성

• 안전(Safe Methods)
  • 호출했을 때 리소스의 변경이 일어나는 것은 안전하지 않다고 말한다.
    • PUT, PATCH, POST, DELETE, ...
  • 호출해도 리소스를 변경하지 않는다.
    • GET, HEAD, ...
  • Q: 리소스를 계속 호출해서 서버에 로그가 쌓여서 장애가 발생하는 경우?
  • A: 안전은 해당 리소스의 변경여부만 고려하고 외적인 부분은 고려하지 않는다.

 

• 멱등(Idempotent Methods)
  • f(f(x)) = f(x)
  • 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
  • 멱등 메서드
    • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
    • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
      • 예) 똑같은 파일을 클라이언트가 똑같이 등록 요청한다고 가정하면 최종적으로 덮어쓰기한 리소스는 처음 호출한 리소스와 결과가 같다.
    • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
    • POST: 멱등하지 않다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
    • PATCH: 멱등하지 않다. 한번 호출할 때 마다 나이를 10 더하는 식으로 설계하면 동일한 요청을 여러 번 했을 때 결과가 계속 달라진다.
  • 멱등 활용
    • 자동 복구 메커니즘에 사용
      • 멱등은 클라이언트에서 DELETE로 요청했을 때, 서버가 TIMEOUT 등으로 정상 응답을 못해주었다면 클라이언트가 같은 요청을 다시 해도 되는지 판단근거가 된다.
      • 멱등한 메서드는 똑같은 요청을 여러 번해도 항상 같은 결과가 나오기 때문에 다시 요청해도 괜찮다.
  • 멱등의 고려 범위
    • 동일한 사용자가 똑같은 요청을 했을 때 결과가 같은(멱등) 것인지를 고려한다.
      • Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?
        • 사용자1: GET -> username:A, age:20
        • 사용자2: PUT -> username:A, age:30
        • 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회
      • A: 멱등은 외부 요인(사용자2)으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.

 

• 캐시가능(Cacheable Methods)
  • 캐시라는 것은 원본 데이터가 변경되지 않고 유지되어야 한다.
    • 데이터 변경 관점
  • 응답 결과 리소스를 캐시해서 사용해도 되는가?
    • 예) 웹브라우저가 큰 이미지를 로컬 PC에 저장해서 사용할 수 있는지여부
    • 큰 이미지를 서버로부터 다시 다운받지 않고 바로 사용할 수 있기 때문에 효율적이다.
  • 캐시가능 HTTP 메서드
    • GET
    • HEAD
    • POST (데이터를 변경할 가능성이 있다)
    • PATCH (데이터를 변경할 가능성이 있다)
  • 실제로는 원본 데이터가 변경되지 않고 유지되는 GET, HEAD 정도만 캐시로 사용한다.
    • 캐시를 하려면 똑같은 리소스와 캐시 키가 맞아야 한다.
      • GET은 URI만 캐시 키로 잡고 캐시 가능(구현이 쉽다)
    • POST, PATCH는 본문 내용(메시지 바디)까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다

---

[참고자료]

모든 개발자를 위한 HTTP 웹 기본 지식, 김영한