본문 바로가기
CS/네트워크

[Network] HTTP 메서드와 활용

by 젊은오리 2023. 5. 13.
728x90

[김영한님의 모든 개발자를 위한 HTTP 웹 기본 지식을 학습 후 정리한 내용입니다.]

순서

  1. HTTP API 생성
  2. HTTP 메서드 - GET, POST, PUT, PATCH, DELETE
  3. HTTP 메서드의 속성
  4. 클라이언트에서 서버로 데이터 전송
  5. HTTP API 설계 예시

1. HTTP API 생성

회원 정보 관리 API를 만들자. 다음과 같은 요구사항이 있다.

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

API를 만들기 앞서 URI를 설계할 때 많은 개발자들은 다음과 같이 설계한다.

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

이렇게 설계하는 것이 과연 좋은 URI 설계일까?

URI 설계시에 가장 중요한 것은 리소스 식별이다. 그렇다면 리소스란 뭘까? 회원을 등록하고 수정하고 조회하는 것이 리소스가 아니다. 바로 회원이라는 개념 자체가 리소스이다. 따라서, 회원이라는 리소스만 식별하면 되기 때문에, 회원 리소스를 URI에 매핑하고, 해당 리소스를 대상으로 하는 행위를 분리하는 편이 더 낫다.

따라서 다음과 같이 설계할 수 있다.

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

이제 여기서 의문이 든다. URI가 같은데 어떻게 조회, 등록, 수정, 삭제라는 것을 구분해야 하는 걸까? 바로 HTTP 메서드로 구분을 한다. 이제부터 HTTP 메서드에 대해서 살펴보자.

2. HTTP 메서드 - GET, POST, PUT, PATCH, DELETE

1. GET

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

2. POST

  • 요청 데이터를 처리하는 메서드이다.
  • 메시지 바디를 통해 서버로 요청 데이터를 전달한다.
  • 서버는 요청 데이터를 처리하고, 내부의 프로세스를 수행한다.
  • 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.

POST를 신규 리소스를 등록하는 메서드로만 알고 있는 경우가 많은데, POST의 스펙을 보면, “POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다.”라고 되어 있다.

보통은 다음 3가지로 POST를 사용한다.

1)신규 리소스 등록

2) 요청 데이터 처리

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

3) 다른 메서드로 처리하기 애매한 경우

  • ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
  • 애매하면 POST를 사용한다

3. PUT

  • 리소스를 대체하는 메서드이다.
  • 리소스가 있으면 대체, 없으면 생성한다.(덮어버린다.)
  • PUT은 클라이언트가 리소스의 위치를 알고 URI를 지정한다. (POST와 차이점)
  • 어떠한 자원을 수정할 것인가를 서버에 보내야 하기 때문에 알 수 밖에 없다.
  • PUT은 “수정” 보다는 “덮어 씌우기”에 가깝다.

4. PATCH

  • 리소스를 부분 변경하는 메서드이다.

5. DELETE

  • 리소스를 제거하는 메서드이다.

 

4. HTTP 메서드의 속성

1. 안전(Safe)

  • 호출해도 리소스를 변경하지 않는다.
  • Q: 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생한다면?
  • A: 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다

2. 멱등(Idempotent)

  • 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다. f(f(x)) = f(x)
  • 멱등 메서드 • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다. • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다. • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다. • POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
  • 자동 복구 메커니즘에 사용된다.
  • 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.

3. 캐시 가능(Cacheable)

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

 

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

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

1. 쿼리 파라미터를 통한 데이터 전송

  • GET
  • 주로 정렬 필터(검색어)

2. 메시지 바디를 통한 데이터 전송

  • POST, PUT, PATCH
  • 회원 가입, 상품 주문, 리소스 등록, 리소스 변경

그럼 이제부터 1)정적 데이터 조회 2)동적 데이터 조회 3)HTML form을 통한 데이터 전송 4)API를 통한 데이터 전송 이 4가지 상황에 대해서 어떤 식으로 데이터를 전송하는지 살펴보자.

 

<정적 데이터 조회하기>

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

 

<동적 데이터 조회하기>

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

 

<HTML Form 데이터 전송>

  • Form은 GET, POST만 지원한다.(주로 POST를 사용한다.)
  • 주로 회원 가입, 상품 주문, 데이터 변경 시 사용한다.
  • Content-Type: application/x-www-form-urlencoded 사용 시 메시지 바디를 통해서 전송한다.
  • Content-Type: multipart/form-data 사용 시 파일 업로드를 전송할 수 있다.

 

<HTML API 데이터 전송>

  • 서버 to 서버, 클라이언트-웹서버, 클라이언트-앱서버 등의 환경에서 사용한다.
  • 클라이언트-웹서버의 경우 AJAX을 사용한다.
  • Content-Type: application/json을 주로 사용한다. (사실상 표준)

 

6. HTTP API 설계 예시

API 설계 - POST 기반 등록

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

※POST - 신규 자원 등록 특징

1) 클라이언트는 등록될 리소스의 URI를 모른다.

  • 회원 등록 /members -> POST
  • POST /members

2) 서버가 새로 등록된 리소스 URI를 생성해준다.

  • HTTP/1.1 201 Created
  • Location: /members/100

3) 컬렉션(Collection)

  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

API 설계 - PUT 기반 등록

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

※PUT - 신규 자원 등록 특징

1) 클라이언트가 리소스 URI를 알고 있어야 한다.

  • 파일 등록 /files/{filename} -> PUT
  • PUT /files/star.jpg

2) 클라이언트가 직접 리소스의 URI를 지정한다. 3) 스토어(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 사용 특징

1) HTML FORM은 GET, POST만 지원

2) 컨트롤 URI

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

URI 설계 참고서 : https://restfulapi.net/resource-naming

728x90
저작자표시

'CS > 네트워크' 카테고리의 다른 글

[Network] HTTP 일반정보, 쿠키에 관련된 헤더  (1) 2023.05.17
[Network] HTTP 상태코드 정리  (1) 2023.05.17
[Network] HTTP의 구조와 특징 정리  (0) 2023.05.11
[Network] 인터넷 네트워크 정리  (0) 2023.05.10
[Network] REST, RESTful API 개념 정리  (0) 2022.07.03

관련글

댓글

티스토리툴바