[HTTP]HTTP 메서드

HTTP API 

API URI 설계

URI(Uniform Resource Identifier)

 

회원 목록을 조회, 회원 조회, 회원 등록, 회원 수정, 회원 삭제를 하는 URI를 설계한다고 하면

각각 read-member-list, read-member-by-id ... 이런 식으로 설계하는 것은 좋은 URI설계가 아니다.

URI설계에서 가장 중요한 것은 리소스를 식별할수 있어야 한다.

리소스의 의미는 무엇일까. 회원을 등록하고 수정하고 조회하는 것은 리소스가 아니다.

회원이라는 개념 자체가 바로 리소스이다. ( 예: 미네랄을 캐라 → 미네랄이 리소스 )

그렇다면 리소스를 어떻게 식별하는게 좋을까?

회원을 등록하고 수정하고 조회하는 것을 모두 배제해야 한다.

회원이라는 리소스만 식별하면 된다. → 회원 리소스를 URI에 매핑

그렇게 리소스를 식별해서 URI를 설계하면 다음과 같다.

회원 목록 조회 /members
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}
참고: 계층 구조상 상위를 컬렉션으로 보고 복수 단어 사용 권장 (member → members)

하지만 이렇게 리소스로만 식별을 하면 조회, 등록, 수정, 삭제를 어떻게 구분해야 할까.

리소스와 행위를 분리해야 한다. 가장 중요한 것은 리소스를 식별하는 것이다.

URI는 리소스만 식별을 하고, 리소스와 해당 리소스를 대상으로 하는 행위를 분리해야 한다.

* 리소스: 회원  *행위: 조회, 등록, 삭제, 변경

리소스는 명사이고 행위는 동사이다. 행위(메서드)를 구분하는 방법은 HTTP 메서드가 대신해준다.

---

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

GET은 리소스를 조회하는 메서드이다.

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

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

GET은 클라이언트에서 서버로 메시지를 전달하면 서버는 요청한 데이터를 확인하고 해당하는 정보를 클라이언트에게 전달하게 된다.

POST

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

{
   "username": "hello",
   "age": 20
}

POST는 서버에게 데이터를 전달해서 처리해달라는 메서드이다.

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

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

주로 전달된 데이터로 신규 리소스를 등록하거나 프로세스를 처리하는데 사용된다.

그렇다면 POST는 요청 데이터를 어떻게 처리한다는 뜻일까.

스펙: POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다.

예를 들어 POST는 다음과 같은 기능에 사용된다.

· HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
   → 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
· 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
   → 예) 게시판 글쓰기, 댓글 달기
· 서버가 아직 식별하지 않은 새 리소스 생성
   → 예) 신규 주문 생성
· 기존 자원에 데이터 추가
   → 예) 한 문서 끝에 내용 추가하기

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

POST 정리

1. 새 리소스 생성(등록)
  · 서버가 아직 식별하지 않은 새 리소스 생성

2. 요청 데이터 처리
  · 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
  예) 주문에서 결제완료 ▷ 배달시작 ▷ 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
  · POST의 결과로 새로운 리소스가 생성되지 않은 수도 있음
   예) POST /orders/{orderId}/start-delivery (컨트롤 URI)

3. 다른 메서드로 처리하기 애매한 경우
   예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
  · 애매하면 POST

컨트롤 URI는 리소스만으로 모두 식별할 수 없는 상황에서 사용하는 URI이다.

리소스만으로 최대한 설계를 하지만 어쩔 수 없는 부분에 한해서 컨트롤 URI로 설계를 해야 한다.

PUT

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

{
   "username": "hello",
   "age": 20
}

PUT은 리소스를 대체하는 메서드이다.

리소스가 있으면 대체되고, 리소스가 없으면 생성한다. 쉽게 이야기해서 덮어버린다.

POST와의 가장 큰 차이점은 POST는 /members로 members에 추가를 해서 몇 번에 추가되는지는 모른다.

하지만 PUT은 클라이언트가 리소스를 식별한다. ( 예: /members/100 )

클라이언트가 리소스 위치를 알고 URI를 지정하는 것이다.

여기서 주의해야할점은 리소스를 완전히 대체한다는 것이다.

예를들어 기존에 /members/100 에는 username: young, age: 20이라는 리소스가 있을 때,

age만 50으로 변경하려고 PUT을 사용해 age:50이라는 정보만 대체할 경우

기존에 있던 username필드는 완전히 사라지고, age: 50이라는 리소스만 남게 된다.

PUT은 수정하는 메서드가 아닌, 기존에 있는 데이터를 완전히 지우고 새로운 데이터를 추가할 때 사용된다.

이렇게 부분적인 리소스를 변경하기 위해서는 PATCH를 사용해야 한다.

PATCH

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

{
   "age":50
}

PATCH는 리소스의 부분만 변경을 하는 메서드이다.

PATCH는 members/100에 username과 age리소스가 있을 때 age의 리소스만 변경할 때 사용된다.

간혹가다가 PATCH를 지원하지 않는 서버가 있다. 그럴 때는 POST를 사용하면 된다.

DELETE

DELETE /members/100 HTTP/1.1
Host: localhost:8080

DELETE는 이름 그대로 리소스를 제거할 때 사용된다.

---

HTTP 메서드의 속성

안전 - Safe

안전은 호출해도 리소스를 변경하지 않는다.

GET은 호출해도 리소스를 변경하지 않으니 안전하다고 말할 수 있다.

하지만 POST, PUT, DELETE는 리소스를 변경하고 삭제하는 메서드이니 안전하지 않다.

GET이 계속 호출해서, 로그 같은 게 쌓여서 장애가 발생하는 상황이 있을 수 있지만,

안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.

해당 리소스가 변하는지 변하지 않는지 그런 부분만 고려한다.

멱등 - Idempotent

멱등은 간단하게 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같아야 한다. ▷ f(f(x)) = f(x) 

멱등 메서드
  · GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
  · PUT: 결과를 대체한다. 따라서 같은 요청을 여러 번 해도 최종 결과는 같다.
  · DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
  · POST: 멱등이 아니다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.

멱등을 활용한 예시로는 자동 복구 메커니즘을 생각하면 된다.

서버가 TIMEOUT 등으로 정상 응답을 못주었을 때,

클라이언트가 같은 요청을 다시 해도 되는가? 에 대한 판단 근거가 된다.

만약 클라이언트에서 DELETE를 서버에 전송했는데 서버에서 응답이 없을 때,

클라이언트에서 다시 DELETE를 재시도하는 것은 문제가 없다.

DELETE는 멱등하기 때문에 여러 번 반복해도 결과가 똑같기 때문이다.

캐시 가능 - Cacheable

웹 브라우저에 큰 이미지를 요청을 하면 다음에 또 큰 리소스를 요청할 필요가 없다.

그래서 웹 브라우저는 이미지를 저장을 하고 있다. 이것을 이제 캐시라고 할 수 있다.

GET, HEAD, POST, PATCH는 캐시가 가능하다.

하지만 실제로는 GET, HEAD 정도만 캐시로 사용하고 있다.

그 이유로는 POST와 PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현하기 쉽지 않기 때문이다.

---

HTTP 메서드 활용

클라이언트에서 서버로 데이터 전송

클라이언트에서 서버로 데이터를 전송하는 전달 방식에는 크게 2가지가 있다.

· 쿼리 파라미터를 통한 데이터 전송
   → GET
   → 주로 정렬 필터(검색어)
· 메시지 바디를 통한 데이터 전송
   → POST, PUT, PATCH
   → 회원 가입, 상품 주문, 리소스 등록, 리소스 변경

클라이언트에서 서버로 데이터를 전송하는 상황에는 대표적으로 4가지 상황이 있다.

· 정적 데이터 조회
   → 이미지, 정적 텍스트 문서
· 동적 데이터 조회
   → 주로 검색, 게시판 목록에서 정렬 필터(검색어)
· HTML Form을 통한 데이터 전송
   → 회원 가입, 상품 주문, 데이터 변경
· HTTP API를 통한 데이터 전송
   → 회원 가입, 상품 주문, 데이터 변경
   → 서버 to 서버, 앱 클라이언트, 웹 클라이언트(Ajax)

정리

정적 데이터 조회
· 이미지, 정적 텍스트 문서
· 조회는 GET 사용
· 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회 가능

동적 데이터 조회
· 주로 검색, 게시판 목록에서 정렬 필터(검색어)
· 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
· 조회는 GET 사용
· GET은 쿼리 파라미터 사용해서 데이터를 전달

HTML Form 데이터 전송
· HTML Form submit시 POST 전송
   예) 회원 가입, 상품 주문, 데이터 변경
· Content-Type: application/x-www-form-urlencoded 사용
  · form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)
  · 전송 데이터를 url encoding 처리
      예) abc김 → abc%EA%B9%80
· HTML Form은 GET 전송도 가능
· Content-Type: multipart/form-data
  · 파일 업로드 같은 바이너리 데이터 전송 시 사용
  · 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능(그래서 이름이 multipart)
· 참고: HTML Form 전송은 GET, POST만 지원

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

HTTP API 설계 예시

HTTP API 설계 예시로는 대표적으로 3가지 예시가 있다.

· HTTP API - 컬렉션
   · POST 기반 등록
   예) 회원 관리 API 제공
·  HTTP API - 스토어
   · PUT 기반 등록
   예) 정적 컨텐츠 관리, 원격 파일 관리
· HTML FORM 사용
   · 웹 페이지 회원 관리
   · GET, POST만 지원

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

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

POST의 신규 자원 등록 특징으로는 클라이언트는 등록될 리소스의 URI를 모른다.

회원 등록 /members → POST
POST /members

클라이언트가 결정하는 것이 아닌 서버가 새롭게 등록될 리소스의 URI를 생성해주기 때문이다.

HTTP/1.1 201 Created
Location: /members/100

이러한 형식을 컬렉션(Collection)이라고 한다.

컬렉션은 서버가 관리하는 리소스 디렉터리이다.

서버가 리소스의 URI를 생성하고 관리해준다. 여기서 컬렉션은 /members가 된다.

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

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

PUT의 신규 자원 등록 특징으로는 클라이언트가 리소스 URI를 알고 있어야 한다.

파일 등록 /files/{filename} → PUT
PUT /files/star.jpg

이것이 POST 기반 등록과 PUT 기반 등록의 가장 큰 차이점이다.

클라이언트가 직접 리소스의 URI를 지정한다는 것이다.

이러한 형식을 스토어(Store)이라고 한다.

스토어는 클라이언트가 관리하는 리소스 저장소이다.

클라이언트가 리소스의 URI를 알고 관리를 한다. 여기서 스토어는 /files가 된다.

실무에서는 컬렉션과 스토어 둘 중에서 컬렉션을 대부분 사용한다.

PUT은 거의 대부분 잘 사용하지 않는다.

HTML FORM 사용

· HTML FORM은 GET, POST만 지원
· AJAX 같은 기술을 사용해서 해결 가능 → 회원 API 참고
· 여기서는 순수 HTML, HTML FORM 이야기
· GET, POST만 지원하므로 제약이 있음

· 회원 목록 /members → GET
· 회원 등록 폼 / member/new → GET
· 회원 등록 / member/new, /members → POST
· 회원 조회 /members/{id} → GET
· 회원 수정 폼 /members/{id}/edit → GET
· 회원 수정 /members/{id}/edit, members/{id} → POST
· 회원 삭제 /members/{id}/delete → POST

HTML FORM은 GET과 POST만 지원을 한다.

이러한 제약을 해결하기 위해서는 동사로 된 리소스 경로(컨트롤 URI)를 사용해야 한다.

POST의 /new, /edit, /delete가 컨트롤 URI이다.

HTTP 메서드로 해결하기 애매한 경우에만 사용을 한다.(HTTP API는 포함)

여기서 중요한 것은 컨트롤 URI를 무식하게 사용해서는 안된다.

최대한 리소스라는 개념을 가지고 URI를 설계하고, 그런 상황에서 설계가 안될 때 컨트롤 URI를 사용해야 한다.

HTTP 메서드 활용 - 정리

· HTTP API - 컬렉션
   → POST 기반 등록
   → 서버가 리소스 URI 결정

· HTTP API - 스토어
   → PUT 기반 등록
   → 클라이언트가 리소스 URI 결정

· HTML FORM 사용
   → 순수 HTML + HTML form 사용
   → GET, POST만 지원

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

→ https://restfulapi.net/resource-naming

---

출처: [인프런]모든 개발자를 위한 HTTP 웹 기본 지식