http method

웹의 리소스 식별

 

리소스란?

HTTP 요청 또는 응답 대상을 리소스라고 하며, 웹 페이지, 문서,이미지 등 그 어떤 것이든 리소스가 될 수 있다. HTTP에서 각 리소스는 URI(URL+URN(잘 사용되지 않음))로 식별된다.

즉, 쉽게말해 리소스는 클라이언트와 서버간 주고 받는 어떠한 데이터(웹페이지 ,문서, 이미지, 모든 웹 콘텐츠 등)인 것이고, http는 클라이언트와 서버간 리소스를 안전하게 요청 또는 응답받기 위해 규칙을 제공하는 프로토콜인 것이다.

 

좋은 API URI 설계 규칙

• 가장 중요한 것은 리소스를 식별 -> 리소스를 URI에 매핑 - 예: /members(리소스)/100 - 회원 조회, /members(리소스)/200 - 회원 등록 등.
• 리소스와 리소스를 처리하는 행위를 분리

 

HTTP 메서드 (행위, 리소스를 처리하는 역할)

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

---

GET과 POST메서드

GET

• 특징 : 리소스 조회
• 서버에 전달하고 싶은 데이터는 query string(쿼리 파라미터)를 통해 전달(URL path뒤에 나오는 ? 다음 나오는 K,V)
• 최근 스펙에서 GET에서도 메시지 바디를 사용할 수 있으나 권장하지 않음(아직까지 지원하는 서버가 많지 않음)

POST

• 특징 : 요청 데이터 처리
• POST는 메시지 바디를 통해 서버로 요청 데이터 전달
• 메시지 바디를 통해 전달된 요청 데이터를 서버에서 모두 처리
• 주로 전달된 데이터로 신규 리소스를 등록하거나, 프로세스를 처리하는데 사용됨.

POST의 요청 데이터 처리 방식

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

GET, POST 정리

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

---

PUT, PATCH, DELETE 메소드

PUT

• 리소스를 대체
  • 이미 리소스가 존재한다면 완전히 대체하고(덮어버림) 없으면 생성하는 것이 특징
• 중요: 클라이언트가 리소스를 식별할 수 있어서 URI를 지정할 수 있다. (POST와 차이점)
• PUT은 리소스를 수정하는 것이 아닌 완전히 대체(덮는)하므로, 수정이 필요할 경우 리소스 부분 변경에 적합한 PATCH를 사용한다.
• 그러나 PATCH가 지원하지 않는 서버들이 있다. 그럴때는 POST를 사용할 것.

PATCH

• 리소스 부분 변경(일부 수정)에 적합

DELETE

• 리소스 제거