[HTTP] HTTP 메소드

본 포스팅은 [인프런] 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 바탕으로 공부하고 정리한 글입니다.

 

HTTP API 만들기

요구사항

회원 정보 관리 API 만들기

• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제

 

API URI 설계

일반적으로 URI를 설계하고자 했을 때 다음과 같이 설계하는 경우가 많다.

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

하지만, URI 설계에 가장 중요한 것은 리소스 식별이다.

• 리소스란?
  • 회원을 등록하고 수정하고 조회하는 것이 리소스가 아니다.
  • 회원이라는 개념 자체가 리소스이다.
• 리소스를 어떻게 식별할까?
  • 회원을 등록, 수정, 조회하는 것을 모두 배제시킨다.
  • 회원이라는 리소스만 식별하면된다. → 회원이라는 리소스를 URI에 매핑

따라서 리소스 식별, URI 계층 구조를 활용하여 URI를 설계하면 다음과 같다.

참고로 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용을 권장한다. (member → members)

• 회원 목록 조회 /members
• 회원 조회 /members/{id}      어떻게 구분하지?
• 회원 등록 /members/{id}      어떻게 구분하지?
• 회원 수정 /members/{id}      어떻게 구분하지?
• 회원 삭제 /members/{id}      어떻게 구분하지?

여기서 문제가 하나 있다.

URI 설계시 리소스에 매칭하니 조회, 등록, 수정, 삭제에 대한 URI 구분이 어렵다는 것이다.

 

문제를 해결하기 위해 리소스와 행위를 분리해야 한다.

• URI는 리소스만 식별한다.
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리시켜야 한다.
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경
• 리소스는 명사(회원), 행위는 동사(회원을 등록해라)

그렇다면 행위는 어떻게 구분할 수 있을까?

 

HTTP 메소드가 행위의 역할을 대신해준다.

따라서 우리는 URI는 리소스만 식별해놓으면 된다.

 

 

HTTP 메소드

HTTP 메소드는 클라이언트가 서버한테 요청 할 때 기대하는 행동을 의미한다.

• 주요 메소드
  • GET : 리소스 조회
  • POST : 요청 데이터 처리, 주로 등록에 사용
  • PUT : 리소스를 대체, 해당 리소스가 없으면 생성
  • PATCH : 리소스 부분 변경
  • DELETE : 리소스 삭제
• 기타 메소드
  • HEAD : GET과 동일하지만, 메시지 부분을 제외한 상태와 헤더만 반환
  • OPTIONS : 대상 리소스에 대한 통신 가능 옵션을 설명

 

GET

• 리소스를 조회
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다.
  • 메시지 바디를 사용해서 데이터를 전달할 수도 있지만, 지원하지 않는 서버가 많아서 권장하지 않는다.
• 서버는 요청 데이터를 찾아 응답 메시지를 만들어 보낸다.
• 클라이언트는 응답 메시지 받아 화면에 그린다.

 

POST

• 요청 데이터를 처리
• 메시지 바디를 통해 서버로 요청 데이터를 전달한다.
• 서버는 요청 데이터를 처리한다.
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.
• URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할 것인지 리소스마다 따로 정해야 한다. (따로 정해진 것 없음)

 

💡 POST 쓰임새

1. 새 리소스 생성(등록)
2. 요청 데이터 처리
   • 단순 데이터 생성 및 변경을 넘어서 프로세스를 처리해야 하는 경우
     • 예) 주문 → 결제완료 → 배달시작 → 배달완료처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
   • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
     • 예) POST/orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메소드로 처리하기 애매한 경우
   • 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메소드를 사용하기 어려운 경우
   • 애매하면 POST를 사용한다.

 

PUT

• 리소스를 대체
  • 리소스가 없으면 생성
  • 리소스가 있으면 대체 (완전 대체)
  • 동일 폴더가 있을 때 폴더를 덮어버린다고 생각하면 된다.
• 클라이언트가 리소스를 식별한다.
  • 클라이언트가 리소스 위치를 알고 URI에 경로를 지정 → POST와의 큰 차이점

 

PATCH

• 리소스 부분 변경

 

DELETE

• 리소스 제거

 

 

HTTP 메소드 속성

• 안전 (Safe Methods)
• 멱등 (Idempotent Methods)
• 캐시가능 (Cacheable Methods)

HTTP 메소드	RFC	요청에 BODY가 있음	응답에 BODY가 있음	안전	멱등	캐시가능
GET	RFC 7231	아니요	예	예	예	예
HEAD	RFC 7231	아니요	아니요	예	예	예
POST	RFC 7231	예	예	아니요	아니요	예
PUT	RFC 7231	예	예	아니요	예	아니요
DELETE	RFC 7231	아니요	예	아니요	예	아니요
CONNECT	RFC 7231	예	예	아니요	아니요	아니요
OPTIONS	RFC 7231	선택 사항	예	예	예	아니요
TRACE	RFC 7231	아니요	예	예	예	아니요
PATCH	RFC 5789	예	예	아니요	아니요	예

출처 : https://ko.wikipedia.org/wiki/HTTP

 

안전

• 호출해도 리소스를 변경하지 않는다.
  • GET은 변경하지 않음 → 안전
  • POST, PUT, DELETE는 변경이 있음 → 안전하지 않음
• 안전은 해당 리소스가 변하지 않는다는 것만 고려한다.

 

멱등

• 한번 호출하든 두번 호출하든 100번 호출하든 결과가 같아야 한다.
• 멱등 메소드
  • GET : 한번 조회하든, 두번 조회하든 같은 결과가 조회된다.
  • PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
  • DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 같다.
  • POST : 멱등X, 두번 호출하면 같은 결제가 중복해서 발생할 수 있다.
• 활용
  • 자동 복구 메커니즘을 생각하자 !
  • 예) DELETE 요청을 보냈는데 응답이 없을 경우 클라이언트가 자동으로 DELETE를 재시도 한다. (멱등하기 때문에 두번 해도 ok)
• 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
  • 재요청 중간에 다른 곳에서 리소스를 변경해버리는 경우
    • 예) 사용자1 : GET → name:A , age:20
            사용자2 : PUT → name:A, age:30
            사용자1 : GET → name:A, age:30 → 사용자2의 영향으로 데이터 조회 결과가 바뀜
    • 이럴 경우 멱등하지 않다고 판단한다.

 

캐시가능

• 응답 결과 리소스를 캐시해서 사용해도 될까?
• GET, HEAD, POST, PATCH는 캐시 가능하다.
• 실제로는 GET, HEAD 정도만 캐시로 사용한다.
• POST,PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않아 거의 캐시로 사용하지 않는다.

캐시(Cache)
• 웹브라우저가 내부에 데이터나 값(이미지 등)을 저장해 두는 임시장소를 말한다.

 

 

HTTP 메소드 활용

클라이언트 → 서버 데이터 전송

💡 데이터 전달 방식

1. 쿼리 파라미터를 통한 데이터 전송
   • GET일 때 사용
   • 주로 정렬 필터(검색어)에 쿼리 파라미터를 많이 사용
2. 메시지 바디를 통한 데이터 전송
   • POST, PUT, PATCH일 때 사용
   • 회원 가입, 상품 주문, 리소스 등록, 리소스 변경에 많이 사용

 

💡 데이터 전달 상황

• 정적 데이터를 조회할 때
  • 이미지, 정적 텍스트 문서
  • 조회는 GET을 사용한다.
  • 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회가 가능하다.
• 동적 데이터를 조회할때
  • 주로 검색, 게시판 목록에서 정렬 필터(검색어)할 때 추가 데이터를 파라미터로 넘긴다.
  • 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용한다.
  • 조회는 GET을 사용한다.
  • GET은 쿼리 파라미터를 사용해서 데이터를 전달한다.
• HTML Form을 통한 데이터 전송
  • 회원 가입, 상품 주문, 데이터 변경
  • HTML Form 전송은 GET, POST만 지원한다.
    • 데이터 조회는 GET, 데이터 변경은 POST 사용
  • Content-Type
    • application/x-www-form-urlencoded 사용
      • form의 내용을 메시지 바디를 통해서 전송한다.(key-value 형식)
      • 전송 데이터를 url encoding 처리한다. 예) abc김 → abc%EA%B9%80
    • multipart/form-data
      • 파일 업로드 같은 바이너리 데이터 전송시 사용한다.
      • 다른 종류의 여러 파일과 폼의 내용을 함께 전송 가능하다.

HTML Form GET 전송 (조회)

700HTML Form POST 전송 (저장)

 

HTML Form POST 전송 (저장) - multipart

 

• HTTP API를 통한 데이터 전송
  • 회원 가입, 상품 주문, 데이터 변경
  • 서버 to 서버 : 백엔드 서버끼리 통신할 때 사용
  • 앱 클라이언트 : 아이폰, 안드로이드 같은 앱 클라이언트에서 데이터를 전송할 때 사용
  • 웹 클라이언트 : HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(Ajax)
  • POST, PUT, PATCH : 메시지 바디를 통해 데이터 전달
  • GET : 조회시 사용, 쿼리파라미터로 데이터 전달
  • Content-Type
    • application/json을 주로 사용 (사실상 표준)
    • TEXT, XML, JSON 등

HTTP API POST 전송

 

 

HTTP API 설계

• HTTP API - 컬렉션
  • POST 기반 등록
  • 서버가 리소스 URI 결정
  • 예) 회원 관리 API 제공
• HTTP API - 스토어
  • PUT 기반 등록
  • 클라이언트가 리소스 URI 결정
  • 예) 정적 컨텐츠 관리, 원격 파일 관리
• HTML FORM 사용
  • GET, POST만 지원
  • 예) 웹 페이지 회원 관리

신규 데이터 등록 방식으로 POST와 PUT 중에 대부분 POST 기반의 컬렉션을 사용한다.

 

POST 기반 등록 - 회원 관리 시스템

• 회원 목록 /members → GET
• 회원 등록 /members → POST 
• 회원 조회 /members/{id} → GET
• 회원 수정 /members/{id} → PATCH, PUT, POST
• 회원 삭제 /members/{id} → DELETE

 

💡 POST 신규 등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다. 
  • 회원 등록 /members → POST
  • 예) POST/members
• 서버가 새로 등록된 리소스 URI를 생성해준다. (서버가 알아서 데이터 등록하고, 식별할 수 있는 URI 생성)
  • HTTP/1.1 201 Created
    Location: /members/100
• 컬렉션 (Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members이다.

 

PUT 기반 등록 - 파일 관리 시스템

• 파일 목록 /files → GET
• 파일 조회 /files/{filename} → GET
• 파일 등록/files/{filename} → PUT
• 파일 삭제 /files/{filename} → DELETE
• 파일 대량 등록 /files → POST

 

💡 PUT 신규 등록 특징

• 클라이언트가 리소스 URI를 알고 있어야 한다.
  • 파일 등록 /files/{filename} → PUT
  • 예) PUT/files/star.jpg
• 클라이언트가 직접 리소스의 URI를 지정한다.
• 스토어(Store)
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 여기서 스토어는 /files이다.

 

HTML FORM 사용

• 회원 목록 /members → GET
• 회원 등록 폼 /members/new → GET 
• 회원 등록 /members/new, /members → POST
• 회원 조회 /members/{id} → GET 
• 회원 수정 폼 /members/{id}/edit → GET
• 회원 수정 /members/{id}/edit, /members/{id} → POST
• 회원 삭제 /members/{id}/delete → POST (DELETE 지원X)

 

💡 HTML FORM 특징

• HTML FORM은 GET, POST만 지원한다.
• 컨트롤 URI
  • GET, POST만 지원하므로 제약이 있다.
  • 이런 제약을 해결하기 위해 동사로된 리소스 경로를 사용한다.
  • POST의 /new, /edit, /delete가 컨트롤 URI이다.
  • HTTP 메소드로 해결하기 애매한 경우 컨트롤 URI를 사용한다.

 

URI 설계 개념 정리

문서(document)	• 단일 개념 (파일하나, 객체 인스턴스, 데이터 베이스 row) • 예) /members/100, /files/star.jpg
컬렉션(collection)	• 서버가 관리하는 리소스 디렉토리 • 서버가 리소스의 URI를 생성하고 관리 • 예) /members
스토어(store)	• 클라이언트가 관리하는 자원 저장소 • 클라이언트가 리소스의 URI를 알고 관리 • 예) /files
컨트롤러(controller), 컨트롤 URI	• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행 • 동사를 직접 사용 • 예) /members/{id}/delete

http://restfulapi.net/resource-naming