HTTP 메서드와 활용

HTTP API 만들어보기

요구사항

회원 정보 관리 API

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

API URI 고민

• 리소스의 의미
  • 회원을 등록, 수정, 조회하는 게 리소스가 아님
  • 회원이라는 개념 자체가 바로 리소스
• 리소스를 어떻게 식별하는 게 좋을까?
  • 회원을 등록, 수정, 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑
  • 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 (member > members)

API URI 설계

리소스 식별, URI 계층 구조 활용

역할	좋지 못한 URI	좋은 URI
회원 목록 조회	/read-member-list	/members
회원 조회	/read-member-by-id	/members/{id}
회원 등록	/create-member	/members/{id}
회원 수정	/update-member	/members/{id}
회원 삭제	/delete-member	/members/{id}

가장 중요한 것은 리소스 식별

리소스와 행위를 분리

• URI는 리소스만 식별!
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사
• 행위는 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

• 리소스 조회
• 서버에 전달할 데이터는 query를 통해서 전달
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만 권장하지 않음

GET 실행 과정

GET 메시지 전달

GET 메서드로 쿼리스트링에 원하는 데이터를 작성하여 HTTP 메시지를 서버로 보낸다.

GET 서버 도착

서버에서 도착한 메시지를 보고 내부의 데이터베이스를 조회하여 데이터를 만든다.

GET 응답 데이터

서버에서 생성한 데이터를 응답 메시지로 보낸다.

POST

POST /members HTTP/1.1
Content-Type: application/json
{
 "username": "hello",
 "age": 20
}

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능 수행
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

POST 실행 과정

POST 메시지 전달

/mebers URI로 POST를 전달할 때 필요한 데이터를 body에 담아서 보낸다.

POST 신규 리소스 생성

서버에서는 받은 데이터로 신규 리소스를 생성하고 데이터베이스에 저장한다.

POST 응답 데이터

신규 리소스를 생성하면 보통 신규 리소스가 생성된 URI를 Location으로 포함하고 body에 등록된 데이터도 같이 전송하게 된다.

POST 정리

이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함. => 정해진 것이 없음

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

PUT

PUT /members/100 HTTP/1.1
Content-Type: application/json
{
 "username": "hello",
 "age": 20
}

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 덮어쓰기
• 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점

PUT 실행 과정

PUT 리소스 있을 때1

PUT 리소스 있을 때2

리소스가 있는 경우 /members/100에 해당하는 리소스의 정보를 대체하게 된다.

PUT 리소스 없을 때1

PUT 리소스 없을 때2

리소스가 없는 경우에는 POST처럼 신규 리소스를 생성하게 된다.

PUT 리소스 대체1

PUT 리소스 대체2

PUT은 리소스를 완전히 대체하기 때문에 주의해야 한다.

PATCH

PATCH /members/100 HTTP/1.1
Content-Type: application/json
{
 "age": 50
}

• 리소스 부분 변경

PATCH 실행 과정

PATCH 리소스 부분 변경1

PATCH 리소스 부분 변경2

username 필드에 관한 데이터 없이 age 필드만 정의해서 요청을 하게되면 해당 리소스에 age 값만 변경된다.

DELETE

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

• 리소스 제거

DELTE 실행 과정

DELETE 리소스 제거1

DELETE 리소스 제거2

HTTP 메서드의 속성

메서드 정보

안전 (Safe Methods)

• 호출해도 리소스를 변경하지 않는다
• 해당 리소스만 고려하기 때문에 계속 호출해서 로그 등이 쌓여 장애가 발생하는 부분까진 고려하지 않음

멱등 (Idempotent Methods)

• f(f(x)) = f(x)
• 몇 번 호출하든 결과가 똑같음
• 멱등 메서드
  • GET : 몇 번 조회해도 같은 결과가 조회된다
  • PUT : 결과를 대체하기 때문에 여러번 해도 결과는 같다
  • DELETE : 여러번 해도 삭제된 결과는 똑같다
  • POST : 멱등이 아니라 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다
• 활용
  • 자동 복구 메커니즘
  • 서버가 정상 응답을 못 주었을 때, 같은 요청을 해도 되는 지 판단의 근거
• 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않음
  • 예) 재요청 중간에 다른 곳에서 리소스를 변경했을 때

캐시가능 (Cacheable Methods)

• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• GET, HEAD, POST, PATCH 캐시가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용
  • POST, PATCH는 구현이 쉽지 않음

HTTP 메서드 활용

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

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

정적 데이터 조회

정적 데이터 조회

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

동적 데이터 조회

동적 데이터 조회

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

HTML Form을 통한 데이터 전송

FORM 데이터 전송1

action="/save" method="post"
POST 방식으로 /save URI를 통해 데이터를 전송하도록 작성되있다.
이 때 form 태그 내부 input의 정보들이 HTTP 요청 메시지 body에 쿼리 파라미터와 동일한 방식으로 서버로 전송하게 된다.

FORM 데이터 전송2

FORM 데이터 전송3

GET 방식으로 데이터를 전송하면 body 대신 쿼리 파라미터로 전달하게 된다.
하지만 GET은 리소스 변경이 발생하는 곳에서 절대 사용하면 안된다.

FORM 데이터 전송4

enctype="multipart/form-data는 파일, 이미지 등을 서버로 전송할 때 사용된다.
요청 메시지에는 Content-Type으로 multipart/form-data가 적용되고 boundary가 추가된다.
boundary(---XXX)를 통해 input의 데이터를 구분지어서 보내게 되는 데 이 때 여러 부분으로 나뉘는 data를 보내는 Form이라고 할 수 있다.

정리

• HTML Form submit 시 POST 전송
  • 회원 가입, 상품 주문, 데이터 변경
• Content-Type : application/x-www-form-urlencoded 사용
  • form의 내용을 메시지 바디를 통해서 전송 (key=value)
  • 전송 데이터를 url encoding 처리
• HTML Form은 GET 전송도 가능
• Content-Type: mulitipart/form-data
  • 파일 업로드 같은 바이너리 데이터 전송 시 사용
  • 다른 종류의 여러 파일과 폼의 내용을 함께 전송 가능 (그래서 multipart)
• HTML Form 전송은 GET, POST만 지원한다

HTTP API 데이터 전송

API 데이터 전송

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

HTTP API 설계 예시

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

• 회원 목록 : /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

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

• 파일 목록 : /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

HTML FORM 특징

• HTML FORM은 GET, POST만 지원
• AJAX 같은 기술로 해결 가능
• 순수 HTML, HTML FORM은 사용 불가
• GET, POST만 지원하므로 제약이 있음
• 컨트롤 URI
  • GET, POST만 지원하는 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 메서드로 해결하기 애매한 경우 사용 (HTTP API 포함)

정리

• HTTP API - 컬렉션
  • POST 기반 등록
  • 서버가 리소스 URI 결정
• HTTP API - 스토어
  • PUT 기반 등록
  • 클라이언트가 리소스 URI 결정
• HTML FORM 사용
  • 순수 HTML + HTML form 사용
  • GET, POST만 지원

참고하면 좋은 URI 설계 개념

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

출처: 모든 개발자를 위한 HTTP 웹 기본 지식