HTTP 메소드 활용

kimwoody·2022년 4월 1일
0

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

데이터 전달 방식은 크게 2가지

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

정적 데이터 조회

쿼리 파라미터 미사용

요청

GET /static/star.jpg HTTP/1.1
Host: localhost:8080

응답

HTTP/1.1 200 OK
Content-Type: image.jpeg
Content-Length: 34012

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

쿼리 파라미터 사용

https://www.google.com/search?**q=hello&hl-ko**

GET /search?q=hello&hl=ko HTTP/1.1
Host: www.google.com

요청을 받으면 쿼리 파라미터를 기반으로 정렬 필터해서 결과를 동적으로 생성

동적 데이터 조회

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

HTML Form 데이터 전송

POST 전송 - 저장

<form action="/save" method="post">
	<input type="text" name="username" />
	<input type="text" name="age" />
	<button type="submit">전송</button>
</form>

웹 브라우저가 생성한 요쳥 HTTP 메시지

POST /save HTTP/1.1
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded

username=kim&age=20

GET 전송 - 저장

<form action="/save" method="get">
	<input type="text" name="username" />
	<input type="text" name="age" />
	<button type="submit">전송</button>
</form>

웹 브라우저가 생성한 요쳥 HTTP 메시지

GET /save?username=kim&age=20 HTTP/1.1
Host: localhost:8080

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

GET 전송 - 조회

<form action="/members" method="get">
	<input type="text" name="username" />
	<input type="text" name="age" />
	<button type="submit">전송</button>
</form>

웹 브라우저가 생성한 요쳥 HTTP 메시지

GET /members?username=kim&age=20 HTTP/1.1
Host: localhost:8080

multipart/form-data (파일 전송)

<form action="/save" method="post" enctype="multipart/form-data">
	<input type="text" name="username" />
	<input type="text" name="age" />
	<input type="file" name="file1" />
	<button type="submit">전송</button>
</form>

username, age 뿐만 아니라 바이트로 된 파일도 함께 전송해야 한다. 이럴 땐 multipart/form-data라는 파일 형식을 사용해야 한다.

웹 브라우저가 생성한 요쳥 HTTP 메시지

POST /save HTTP/1.1
Host: localhost:8080
Content-Type: multipart/form-data; boundary=----XXX
Content-Length: 10457

-----XXX
Content-Disposition: form-data; name="username"

kim
-----XXX
Content-Disposition: form-data; name="age"

20
-----XXX
Content-Disposition: form-data; name="file1"; filename="intro.png"
Content-Type: image/png

이미지에 대한 바이트 정보...
-----XXX...

여러 부분으로 데이터를 나눠서 전송하게 된다.

HTTP API 데이터 전송

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

HTTP API 설계 예시

회원관리 시스템

API 설계 - POST 기반 등록

  • 회원 목록 /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

파일 관리 시스템

API 설계 - PUT 기반 등록

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

PUT - 신규 자원 등록 특징

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

대부분 컬렉션 기반의 POST를 쓴다.

HTML 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

HTML FORM은 GET, POST만 지원

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

0개의 댓글