포스트

05.HTTP 메서드 활용

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

  1. 데이터 전달 방식
    • 쿼리 파라미터
      • GET
      • 주로 정렬 필터나 검색어
    • 메시지 바디
      • POST, PUT, PATCH
      • 회원가입, 물품주문, 리소스변경
  2. 정적 데이터 조회
    • GET 사용
    • 이미지, 정적 텍스트 문서
    • 쿼리 없이 경로를 직접 입력하여 경로에 해당하는 리소스를 그대로 반환
  3. 동적 데이터 조회
    • 쿼리 파라미터 사용
    • 쿼리 파라미터를 key로 사용하여 결과 값 반환
    • 주로 검색, 목록 정렬에 사용
    • GET 사용
  4. HTML Form을 이용한 전송, GET, POST만 가능
    • form 태그 안에 name을 key로 하고 입력된 값을 value로 사용
    • 기본
      • Content-Type: application/x-www-form-urlencoded
      • name=value&name=value 와 같은 쿼리형태로 하여 서버로 데이터 전송
    • form 태그의 enctype=”multipart/form-data” 사용
      • file 전송
      • Content-Type: multipart/form-data; boundary=---xxx
      • ---xxx 형태로 데이터가 들어가는 부분분을 나눈다.
  5. HTTP API 데이터 전송
    • 안드로이드나 ios와 같은 application에서 클라이언트에서 서버로 직접 데이터를 전송해야 할 때
    • Content-Type: application/json
    • 서버에서 서버로 전송
      • 백엔드 시스템 통신
    • 앱 클라이언트
      • 아이폰, 안드로이드
    • 웹 클라이언트
      • HTML에서 Form 전송 대신 JS의 AJAX를 사용
      • 예를 들어 React, VueJs와 같은 웹 클라이언트와 API 통신한다
    • POST, PUT, PATCH : 메시지 바디를 통한 데이터 전송
    • GET : 조회, 쿼리파라미터 사용
    • Content-Type: application/json을 주로 사용

HTTP API 설계

  1. HTTP API - 컬렉션
    • POST 기반 등록
    • 예) 회원 관리 API 제공
      • 회원 목록 /members > GET
      • 회원 등록 /members > POST
      • 회원 조회 /members/{id} > GET
      • 회원 수정 /members/{id} > PATCH, PUT, POST
      • 회원 삭제 /members/{id} > DELETE
    • 클라이언트는 등록될 리소스의 URI를 모른다
      • 회원등록 /members > POST
      • POST /members
    • 서버가 새로 등록된 리소스 URI를 생성한다
      • HTTP/1.1 201 Created
      • Location: /members/100
    • 이런걸 컬렉션이라고 부른다
      • 서버가 관리하는 리소스 디렉토리
      • 서버가 리소스의 URI를 생성하고 관리
      • 여기서 컬렉션은 /members
  2. HTTP API - 스토어
    • PUT 기반 등록
    • 예) 정적 컨텐츠 관리, 원격 파일 관리
      • 파일 목록 /files > GET
      • 파일 조회 /files/{filename} > GET
      • 파일 등록 /files/{filename} > PUT
      • 파일 삭제 /files/{filename} > DELETE
      • 파일 대량 등록 /files > POST
    • 클라이언트가 리소스 URI를 알고 있어야 한다
      • 파일 등록 /files/{filename} > PUT
      • PUT /files/star.jpg
    • 클라이언트가 직접 리소스의 URI를 지정한다
    • 스토어(Store)
      • 클라이언트가 관리하는 리소스 저장소
      • 클라이언트가 리소스의 URI를 알고 관리
      • 여기서 스토어는 /files
  3. HTML FORM 사용
    • 웹 페이지 회원 관리
    • AJAX같은 기술을 사용하지 않는 경우에는 제약이 있다
    • GET, POST만 지원
      • 회원 목록 /members > GET
      • 회원 등록 폼 /members/new > GET
      • 회원 등록 /members/new (or) /members > POST
      • 회원 조회 /members/{id} > GET
      • 회원 수정 폼 /members/{id}/edit > GET
      • 회원 수정 /members/{id}/edit (or) /members/{id} > POST
      • 회원 삭제 /members/{id}/delete > POST
    • 컨트롤 URI 사용
      • 리소스만으로 URI를 구성하지 않고, 행위(동사)로 된 리소스 경로를 사용
      • HTTP 메서드로만 해결하기 애해만 경우에 사용(HTTP API 포함)

URI 설계 개념

  • 문서
    • 단일 개념(파일 하나, 객체 인스턴스, DB row)
    • 예) /members/100, files/star.jpg
  • 컬렉션
    • 서버가 관리하는 리소스 디렉터리
    • 서버가 리소스의 URI를 생성하고 관리
    • 예) /members
  • 스토어
    • 클라이언트가 관리하는 자원 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 예) /files
  • 컨트롤러, 컨트롤 URI
    • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
    • 동사를 직접 사용
    • 예) /members/{id}/delete
  • 참고사이트
출처
  • 인프런의 김영한님의 강의를 듣고 정리한 것입니다.