Intro

본 포스팅에서는 HTTP 메서드의 종류와 이를 활용하여 API를 설계하는 방법을 다룬다.

HTTP API URI 설계

회원 정보 관리를 하는 API를 설계하는 상황을 가정한다.

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

초기 설계는 다음과 같다.

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

초기 설계 수정

초기 설계는 좋은 설계가 아니다.
API 설계는 리소스를 식별하여 설계하는 것이 가장 중요하다.

URI에 대한 고민

URI란 Uniform Resource Identifier이다.
즉, URI를 통해 리소스를 식별할 수 있어야 한다는 이야기이다.

회원을 등록하고 수정하는 등의 작업을 진행하는 API에서는,
회원을 리소스라고 할 수 있다.

이를 바탕으로 다시 설계를 해보자.

개선된 API URI

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

회원 목록 조회 /members
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}

이렇게 URI는 리소스를 식별하는 용도로만 사용한다.

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

그러면, 행위인 회원 조회/등록/수정/삭제를 구분할 방법이 모호해진다.
이를 어떻게 해결하면 좋을까?
이를 HTTP 메서드를 사용하여 구분할 수 있다.

HTTP Method

HTTP Method의 종류

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

리소스를 조회하는 HTTP 메서드이다.
서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다.
메시지 바디를 통해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않는다.

GET 예시

클라이언트가 서버에 GET HTTP 메서드를 사용하여 요청 메시지를 전달한다.

요청 메시지가 서버에 도착한다.

서버는 요청 메시지를 기반으로 응답 메시지를 생성해 클라이언트에게 전달한다.

POST

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

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

요청 데이터를 처리한다.
메시지 바디를 통해 서버로 요청 데이터를 전달한다.
서버는 메시지 바디를 통해 들어온 요청 데이터를 처리한다.
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리 등의 작업을 수행한다.

POST 예시

클라이언트가 서버에 POST HTTP 메서드를 사용하여 요청 메시지를 전달한다.

요청 메시지가 서버에 도착한다.
서버는 메시지 바디에 있는 데이터를 통해 신규 리소스를 생성한다. (데이터베이스에 저장)
그리고 신규 리소스에 대한 URI를 새로 생성한다.

서버는 요청 메시지에 대한 응답코드와 생성된 리소스 등 다양한 정보를 담은 응답 메시지를 생성한다.
그리고 이를 클라이언트에게 전달한다.

PUT

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

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

리소스를 대체한다.
- 리소스가 없으면 생성
- 리소스가 있으면 대체
클라이언트가 리소스를 식별한다는 점이 POST와의 가장 두드러지는 차이점이다.
- 클라이언트가 리소스 위치를 알고 있다.

PUT : 주의 상황

기존에 members/100에 저장되어 있는 회원 정보를 PUT 메서드를 사용해 대체한다고 하자.

age값만 업데이트 하고 싶은데 이렇게 username을 공란으로 두고 PUT 메서드를 사용하면..
username가 없는 새로운 리소스로 대체된다.

PATCH

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

{
    "age":50
}

위의 상황을 해결할 수 있는 HTTP 메서드로서, 리소스를 부분적으로 변경할 수 있다.

DELETE

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

저장되어 있는 리소스를 제거할 수 있는 HTTP 메서드이다.

HTTP Method의 속성

HTTP 메서드의 속성은 다음과 같다.

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

안전(Safe)

호출해도 리소스를 변경하지 않는다.
지속적인 호출로 로그가 쌓여 장애가 발생하면?
- 해당 리소스만 고려하고, 이런 경우는 고려하지 않는다.

멱등(Idempotent)

몇 번 호출하든 호출 후 결과가 같다.
멱등한 메서드
- GET : 몇 번 조회하든 같은 결과가 조회된다.
- PUT : 결과를 대체한다. 몇 번을 호출하든 대체되기 때문에 결과가 같다.
- DELETE : 결과를 삭제한다. 몇 번을 삭제하든 삭제된 결과는 같다.
멱등하지 않은 메서드
- POST : 같은 메서드를 두 번 호출하면 결과가 중복될 수 있다.
  - e.g. 같은 결제를 두 번 하면 주문 번호 중복 오류가 날 수 있다.
멱등은 외부 요인으로 리소스가 변경되는 것 까지는 고려하지 않는다.
- e.g. GET 과 GET 사이에 다른 사용자의 PUT으로 인해 리소스가 변경된 경우

캐시가능(Cacheable)

응답 결과 리소스를 캐시해서 사용해도 되는가?
GET, HEAD, POST, PATCH 캐시가능하다.
실제로는 GET, HEAD 정도만 캐시로 사용한다.
- POST, PATCH는 본문 내용(body)까지 캐시 키로 고려해야 하는데, 구현이 까다롭다.

HTTP Method의 활용

클라이언트에서 서버로 데이터를 전송하는 4가지 상황을 기준으로 설명한다.

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

정적 데이터 조회

가장 큰 특징으로는 쿼리 파라미터(쿼리 스트링)을 사용하지 않는다는 것이다.

이미지, 정적 텍스트 문서 등을 조회할 때 사용된다.
GET을 사용한다.
쿼리 파라미터 없이 리소스의 경로를 바탕으로 단순히 조회 가능하다.

동적 데이터 조회

쿼리 파라미터를 사용하여 데이터를 조회한다.
파라미터 정보를 기반으로 정보를 필터링/정렬 작업을 거친 후 결과를 생성해낸다. (동적)

주로 검색, 게시판 목록에서 정렬 필터(검색어)
- 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
조회는 GET을 사용한다.
GET은 쿼리 파라미터를 사용해서 데이터를 전달한다.
- GET은 body를 사용하지 않는 것이 일반적이므로

HTML Form 데이터 전송

HTML Form을 이용해서 HTTP 요청 메시지를 전송한다.
HTML 문서에서 HTML Form에 각종 정보를 입력 후, 버튼을 클릭하면 웹 브라우저에서 HTTP 메시지를 생성해주는 것이다.

POST 전송 - 저장

그 중 POST HTTP Method를 사용할 때는 이렇게 구성됩니다.

GET 전송 - 저장

위의 예시를 아래와 같이 GET을 이용할 수도 있다.

HTTP body에 들어갈 내용을 쿼리 파라미터로 넣는 것이다.

물론 당연히 조회하는 경우에서만 사용해야 하고 리소스를 바꾸는 경우에는 GET을 사용하지 않아야 한다.

multipart/form data

enctype을 "multipart/form-data로 설정할 수 있다.
이렇게 설정하면 바이트로 되어 있는 파일까지 전송할 수 있다.
그리고 각 데이터들에 대한 구분자는 웹 브라우저가 임의의 boundary값을 정해 사용한다.

HTTP API 데이터 전송

직접 HTTP API를 만들어서 데이터를 전송하는 방법이다.
라이브러리로 구현 되어 있는 경우가 많기에 손쉽게 API를 제작할 수 있다.
예제의 body는 json으로 구현되어 있는 모습이다.

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

HTTP API 설계 시

PUT? POST? PATCH?

예제 1

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

새로운 회원 등록을 할 때는 POST를 사용해야 한다는 것은 명확하다.
하지만 회원 수정의 경우는 어떡할까?

기존 정보를 수정하는 기능이 강하다 -> PATCH
기존 정보를 모두 덮어써도 된다(글쓰기 같은 경우) -> PUT
아 모르겠다 애매해 -> POST

POST 기반 신규 자원 등록

위와 같은 예제에서, POST 기반 신규 자원 등록의 특징을 확인할 수 있다.

클라이언트는 새로 등록될 리소스의 URI를 모른다.
서버가 새로 등록된 리소스의 URI를 생성한다.
- 생성된 리소스의 URI는 HTTP Response 메시지에서 확인된다.
```
HTTP/1.1 201 Created
Location: /members/100
```
이를 컬렉션(Collection)이라 부른다.
- 서버가 관리하는 리소스 디렉터리
- 서버가 리소스의 URI를 생성하고 관리한다.
- 여기서 컬렉션은 /members이다.

예제 2

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

이렇게 파일 명으로 URI를 설계하는 경우는 PUT을 사용해야 한다.
경로가 파일 명으로 지정되기 때문에, 클라이언트가 리소스의 URI를 알고 있다.
URI를 설계하는 사람이 파일을 대량으로 등록할 때는 /files에서 POST를 쓰기로 임의 지정할 수 있다.

PUT 기반 신규 자원 등록