유지연

유지연

I’m a junior web developer.
Let’s code with me!

[HTTP] 5. HTTP 메서드 활용

업데이트:
4 분 소요

김영한님의 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 듣고 정리했습니다.

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

데이터를 전달하는 방식 2가지

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

  • GET 메서드
  • URI 끝에 쿼리 파라미터를 넣어 전송한다.
  • 예) 키워드로 검색, 게시판에 정렬 조건을 넣을 때

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

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

클라이언트에서 서버로 데이터를 전달하는 상황

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

정적 데이터 조회

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

http

동적 데이터 조회

  • 쿼리 파라미터를 사용한다.
  • 주로 검색, 게시판 목록에서 특정 검색어 기준으로 정렬을 할 때 사용한다.
  • 조회 조건을 걸어주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용한다. 조회는 GET을 사용한다.
  • 클라이언트에서 쿼리 파라미터를 통해 추가적인 정보를 제공하고, 서버에서는 쿼리 파라미터를 key-value로 사용하여 그 데이터를 기반으로 동적으로 결과를 생성한다.

http

HTML Form 데이터 전송

POST 전송 - 저장

  • form의 submit 버튼을 누르면, 웹 브라우저가 폼의 데이터를 읽어서 HTTP 메시지를 생성한다.
  • POST 방식에서는 데이터를 메시지 바디에 넣는데, 쿼리 파라미터와 유사한 key-value 형태의 데이터를 서버에 전송한다.

http

GET 전송 - 저장

  • GET을 이용해서도 데이터를 저장할 수 있다. GET 방식에서는 메시지 바디를 쓰지 않고 form 태그의 데이터를 URL 경로에 넣는다.

http

GET 전송 - 조회

  • 주의! GET은 조회에만 사용한다. 리소스 변경이 발생하는 곳에 사용하면 안된다.

http

multipart/form-data

  • 이미지를 함께 전송해야 하는 경우, multipart/form-data를 지정한다. 멀티로 여러 타입의 데이터를 보낼 수 있는데, 주로 바이너리 데이터를 사용할 때 사용한다. 메시지 바디에 데이터를 넣는다.

http

http

정리

  • HTML Form submit시 POST 전송
    • 예) 회원 가입, 상품 주문, 데이터 변경
  • 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만 지원

HTTP API 전송

  • 클라이언트에서 서버로 데이터를 바로 전송해야 하는 경우가 있다.
    • 예) 안드로이드나 아이폰 애플리케이션에서는 클라이언트에서 서버로 데이터를 바로 전송해야 한다.

http

정리

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

(2) HTTP API 설계 예시

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

회원 관리 시스템

API 설계 - POST기반 등록

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

POST - 신규 자원 등록 특징

  • 클라이언트는 등록될 리소스의 URI를 모른다.
    • 회원 등록 /members → POST
    • POST /members
  • 서버가 새로 등록된 리소스 URI를 생성한다. 그리고 응답 메시지에 URI를 보낸다.
HTTP/1.1 201 Created
Location: /members/100
  • 컬렉션(Collection)
    • 서버가 관리하는 리소스 디렉토리
    • 서버가 리소스의 URI를 생성하고 관리
    • 여기서 컬렉션은 /members

파일 관리 시스템

API 설계 - PUT 기반 등록

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

PUT - 신규 자원 등록 특징

  • 클라이언트가 리소스 URI를 알고 있어야 한다. (POST는 서버가 리소스 URI를 생성!)
    • 파일 등록 /files/{filename} → PUT
    • PUT /files/star.png
  • 클라이언트가 직접 리소스의 URI를 지정한다.
    • 파일을 등록할 때, filename을 넣어줘야 한다.즉 클라이언트가 리소스의 URI를 알고 있어야 한다.클라이언트가 등록될 URI를 관리한다. 서버는 요청이 온대로 처리할 뿐이다. 서버는 URI를 관리하지 않는다.
  • 스토어(Store)
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 여기서 스토어는 /files

신규 자원을 등록할 때는 주로 POST 기반의 컬렉션을 사용한다.

HTML FORM 사용

  • HTML FORM은 GET, POST만 지원한다. 제약이 있다.
  • AJAX 같은 기술을 사용하여 해결 가능하다.

API 설계

  • 회원 목록 /members → GET
  • 회원 등록 폼 /members/new → GET
  • 회원 등록 /members/new, /members → POST
    • 등록 폼과 등록의 URI를 동일하게 맞출 수도 있고, 다르게 할 수도 있다.
  • 회원 조회 /members/{id} → GET
  • 회원 수정 폼 /members/{id}/edit → POST
  • 회원 수정 /members/{id}/edit, /members/{id} → POST
    • 수정 폼 자체를 읽어들이는 것은 실제로 어떤 변경이 일어나는 것은 아니다.
  • 회원 삭제 /members/{id}/delete → POST
    • DELETE를 사용할 수 없기 때문에 컨트롤 URI를 사용한다.

컨트롤 URI

  • HTTP FORM은 GET, POST만 지원하므로 제약이 있다. 이런 제약을 해결하기 위해 동사로 된 리소스 경로를 사용한다.
  • GET, POST, PUT, DELETE를 모두 사용할 수 있다면 컨트롤 URI를 사용하지 않아도 된다.
  • POST의 /new, /edit, /delete가 컨트롤 URI이다.
  • 데이터를 조작하거나 변경하기 때문에 컨트롤 URI에는 동사를 사용한다.
  • HTTP 메서드로 해결하기 애매한 경우에 컨트롤 URI를 사용한다.

참고하면 좋은 URI 설계 개념

문서(document)

  • 단일 개념(파일 하나, 객체 인스턴스, 데이터 베이스 row)
  • 예) /members/100, /files/star.png

컬렉션(collection)

  • 서버가 관리하는 리소스 디렉터리
  • 서버가 리소스의 URI를 생성하고 관리하는 것
  • 예) /members

스토어(store)

  • 클라이언트가 관리하는 자원 저장소
  • 클라이언트가 리소스의 URI를 알고 관리하는 것
  • 예) /files

컨트롤러(ontroller), 컨트롤 URI

  • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
  • 데이터를 조작하거나 변경하기 때문에 동사를 직접 사용
  • 예) /members/100/delete
  • 참고 사이트 : https://restfulapi.net/resource-naming/

태그:

카테고리:

업데이트:

참고

2022-02-22 TIL(at work)

업데이트:
5 분 소요

업무 배경 이 업무가 할당된 이유 회사에서 맡고 있는 서비스 중, 회원이 구매를 신청하면 정부24에서 그 컨텐츠를 구매하여 제공을 하는 서비스가 있다. (참고로, 구매를 한다고 바로 완료되는게 아니라 구매 로직을 태운 후 실제로 컨텐츠를 가져오기까지 어느정도 시간이 소요된다....