HTTP

[모든 개발자를 위한 HTTP 웹 기본 지식] HTTP 메서드 활용

kkkkkkkkkkkk 2022. 11. 15. 17:59

 

데이터 전달 방식은 2가지로 구분

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

 

데이터 전달은 5가지로 구분

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

 

정적 데이터 조회

  • 조회는 GET을 사용
  • 쿼리 파라미터는 사용하지 않고 리소스 경로로 단순하게 조회한다.

 

동적 데이터 조회

  • 조회는 GET 을 사용, 쿼리 파라미터를 사용하여 데이터를 전달한다.
  • 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용한다.

 

HTML FORM 데이터 전달

  • HTML FORM 전송은 GET, POST 만 지원한다.
  • submit 시 POST 전송
    • 회원 가입, 상품 주문, 데이터 변경
    • form에 담긴 메시지 바디 내용을 통해서 전송한다.
    • 전송 데이터를 url encoding하여 처리한다.
  • submit 시 GET 전송
    • form 내부의 데이터 정보를 수집하여 쿼리 파라미터로 전달 한다.
    • 리소스 변경에는 사용하면 안된다.
  • HTML FORM 은 파일 전송도 가능하다.
    • content-type:multipart/form-data
      • 파일 업로드 같은 바이너리 데이터 전송 시에 사용한다.
      • 다른 종류의 여러 파일과 폼의 내용을 함께 전송이 가능하다.

 

HTTP API 설계 예시

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

 

API 설계 - POST 기반 등록

  • 회원 목록 → GET
    • /members
      • 회원 정렬 조건이나 검색 조건이 필요하면 쿼리 파라미터를 설계하면 된다.
  • 회원 등록 → POST
    • /members
  • 회원 조회 → GET
    • /members/{id}
    • 계층적 구조로 되어 있어 컬렉션 안의 특정 아이디를 조회한다고 볼 수 있어 가독성도 높다.
  • 회원 수정 → POST, PUT, PATCH
    • /members/{id}
    • PUT은 덮어 씌우기고 PATCH는 부분적 업데이트이기에 회원 정보는 PATCH가 좋지만 전부 변경이 일어나야 한다면 PUT이 좋다. 예를 들어 게시판 글쓰기를 수정하는 경우다.
  • 회원 삭제 → DELETE
    • /members/{id}

 

POST - 신규 자원 등록 특징

  • 클라이언트는 등록된 리스소의 URI 를 모른다.
  • 서버가 새로 등록한 리소스 URI 를 생성해준다.
  • 컬렉션
    • 서버가 관리하는 리소스 디렉토리
    • 서버가 리소스의 URI 를 생성하고 관리
    • 컬렉션은 /members를 뜻한다.

 

API 설계 - PUT 기반 등록

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

 

PUT - 신규 자원 등록 특징

  • 클라이언트가 리소스 URI 를 알고 있어야 한다.
    • 파일 등록
      • /files/image.jpg
  • 클라이언트가 직접 리소스의 URI 를 지정한다.
  • 스토어
    • 클라이언트가 관리하는 리스소 저장소
    • 클라이언트가 리소스의 URI 를 알고 관리
    • 여기서 스토어는 /files 이다.

 

POST 와 PUT 의 방식 중 무엇을 많이 사용할까?

  • 대부분 POST 기반 컬렉션을 많이 사용하고 PUT과 같은 방식은 파일 관리 같은 특수한 경우에만 사용한다.