[F-Lab 모각코 챌린지 14일차] HTTP 메서드 활용

Nami·2023년 6월 14일
0

66일 포스팅 챌린지

목록 보기
14/66
post-custom-banner

HTTP 메서드 활용

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

데이터 전달 방식

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

4가지 상황

  1. 정적 데이터 조회
  • 이미지, 정적 텍스트 문서
  • 조회는 GET 사용
  • 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회 가능
  1. 동적 데이터 조회
  • 주로 검색, 게시판 목록에서 정렬 필터(검색어)
  • 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
  • 조회는 GET 사용
  • 쿼리 파라미터 사용 (ex: q=hello&jl=ko)
    • 쿼리 파라미터를 기반으로 정렬 필터해서 결과를 동적으로 생성
  • GET은 쿼리 파라미터 사용해서 데이터를 전달(권장하지 않음)
  1. HTML Form을 통한 데이터 전송
  • HTML Form submit시 POST 전송
    • (ex: 회원가입,상품주문,데이터변경)
  • Content-Type: application/x-www-form-urlencoded 사용
    • form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)

    • 전송 데이터를 url encoding 처리

      • abc김 ➡️ abc%EA%B9%80
  • HTML Form은 GET 전송도 가능
  • Content-Type: multipart/form-data
    • 파일 업로드 같은 바이너리 데이터 전송시 사용
    • 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능(multipart인 이유)

참고: HTML Form 전송은 GET, POST만 지원

  1. HTTP API를 통한 데이터 전송
  • 서버 To 서버

    • 백엔드 시스템 통신
  • 앱 클라이언트

    • 아이폰, 안드로이드
  • 웹 클라이언트

    • HTML에서 Form 전송 대신 Javascript를 통한 통신에 사용(Ajax)
    • (ex: React, Vue.js 같은 웹 클라이언트와 API 통신)
  • POST, PUT, PATCH: 메시지 바디를 통해 데이터 전송

  • GET: 조회, 쿼리 파라미터로 데이터 전달

  • Content-Type: application/json을 주로 사용(사실상 표준)

    • Text, XML, JSON 등

HTTP API 설계 예시

HTTP API - 컬렉션

POST 기반 등록

ex: 회원관리 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

HTTP API - 스토어

PUT 기반 등록

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

ex: 정적 컨텐츠 관리, 원격 파일 관리

PUT - 신규 자원 등록 특징

  • 클라이언트가 리소스 URI를 알고 있어야 한다.
    - 파일 등록 /files/{filename} ➡️ PUT
    • PUT /files/star.jpg
  • 클라이언트가 직접 리소스의 URI를 지정한다.
  • 스토어(Store)
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 스토어는 /files

HTTPT FORM 사용

  • 웹페이지 회원 관리
  • HTML FORM은 GET, POST만 지원
  • AJAX 같은 기술을 사용해서 해결 가능 ➡️ 회원 API 참고
  • 순수 HTML, HTML Form 이야기
  • GET, POST만 지원하므로 제약이 있음.

회원 목록 /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 (컨트롤 URI)

컨트롤 URI

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

참고하면 좋은 URI 설계 개념

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

URI 설계시 머리론 이해되나 개념적으로 용어가 정리 안될 때, 좋은 프렉티스들이 있는 링크
https://restfulapi.net/resource-naming/


🤔💭

완강 후 전체 섹션을 이야기로 풀 수 있게끔 해보려한다. 내용을 앎에도 말로 풀어내는 건 차이가 있는 것 같다. 블로그에 배운 내용을 정리는 했지만 완전히 인식할 수 있을 만큼 전부 말할 수 있을 정도인지? 블로그 정리는 최대한 간략하게, 그 이후 내가 습득을 제대로 했는지에 대한 체크를 해야겠다.

참조 ✅

post-custom-banner

0개의 댓글