HTTP 메서드 활용

💡** 요약 :** 데이터 전송은 주로 쿼리 파라미터와 메시지 바디를 통해 이루어져. 정적 데이터 조회는 주로 GET으로 처리되고, 동적 데이터 조회는 쿼리 파라미터를 활용해 검색과 필터링이 이뤄져. HTML Form을 사용한 데이터 전송은 회원 가입이나 상품 주문과 같은 경우에 POST로 처리돼, 주로 Content-Type은 application/x-www-form-urlencoded을 사용해.

HTTP API 설계에서는 컬렉션과 스토어 개념이 있어. 컬렉션은 서버가 리소스 URI를 결정하고, 스토어는 클라이언트가 리소스 URI를 결정해. URI 설계에서 문서는 단일 개념을 나타내고, 컬렉션은 서버가 관리하는 리소스 디렉터리를 의미하며, 스토어는 클라이언트가 관리하는 자원 저장소를 나타내. 컨트롤 URI는 추가 프로세스 실행을 위해 동사를 직접 사용해.

간단히 말하면, 데이터 전송 방식과 API 설계에서 각 상황에 맞게 메서드와 구조를 잘 활용하는 게 중요해!

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

사진 및 강의 출처 : 모든 개발자를 위한 HTTP 웹 기본 지식

🖕데이터를 전달하는 방식은 크게 2가지

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

• GET

• 주로 정렬 필터(검색어)

2) 메세지 바디를 통한 데이터 전송

• POST, PUT, PATCH

• 회원 가입, 상품 주문, 리소스 등록, 리소스 변경

👆 4가지 상황

1) 정적 데이터 조회

• 이미지, 정적 텍스트 문서

• 쿼리 파라미터 미사용

• 조회는 GET 사용

• 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순히 조회 가능

2) 동적 데이터 조회

• 주로 검색, 게시판 목록에서 정렬 필터(검색어)

• 쿼리 파라미터 사용

• 데이터 전송이 필요

• 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용

• 조회는 GET 사용

• GET은 쿼리 파라미터 사용해서 데이터를 전달

3) HTML Form을 통한 데이터 전송

• 회원 가입, 상품 주문, 데이터 변경

1. POST 전송 - 저장

• 쿼리 파라미터와 비슷한 형태로 HTTP 바디에 키 - Value로 넣고 서버에 전송

• application/x-www-form-urlencoded : form으로 전송의 클라이언트와 서버와의 약속

2. GET 전송 - 저장

• 메세지 바디를 안쓰기 때문에

• 쿼리파라미터에 넣어버림

3. multipart/form-data

• 파일 전송을 위함

• 여러 컨텐츠에 타입을 보낼 수 있음

정리

1. HTML Form submit시 POST 전송

• 예) 회원 가입, 상품 주문, 데이터 변경

2. Content-Type: application/x-www-form-urlencoded 사용

• form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)

• 전송 데이터를 url encoding 처리

  • 예) abc김 -> abc%EA%B9%80

3. HTML Form은 GET 전송도 가능

4. Content-Type: multipart/form-data

• 파일 업로드 같은 바이너리 데이터 전송시 사용

• 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능(그래서 이름이 multipart)

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

4) HTML API를 통한 데이터 전송

• 회원 가입, 상품 주문, 데이터 변경

• 서버 to 서버, 앱 클라이언트, 웹 클라이언트(Ajax)

ajax란?

• 비동기식 자바스크립트

• HTML 페이지 전체가 아닌 일부분만 갱신할 수 있도록 XMLHttpRequest객체를 통해 서버에 request

정리

1. 서버 to 서버

• 백엔드 시스템 통신

2. 앱 클라이언트

• 아이폰, 안드로이드

3. 웹 클라이언트

• HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX)

• 예) React, VueJs 같은 웹 클라이언트와 API 통신

4. POST, PUT, PATCH: 메시지 바디를 통해 데이터 전송

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

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

• TEXT, XML, JSON 등등

• 지금은 데이터 전송의 JSON이 거의 표준이다.

2. HTTP API 설계 예시

🖕HTTP API - 컬렉션

• POST 기반 등록

• 예) 회원 관리 API 제공

• PUT : 게시글 수정 같은 느낌

회원 관리 시스템 API 설계

POST - 신규 자원 등록 특징

1. 클라이언트는 등록될 리소스의 URI를 모른다.

• 회원 등록 /members -> POST

• POST /members

2. 서버가 새로 등록된 리소스 URI를 생성해준다.

• HTTP/1.1 201 Created Location: /members/100

• POST 등록시 서버가 새로운 URI를 만들어준다는 것이 가장 중요!!

3. 컬렉션(Collection)

• 서버가 관리하는 리소스 디렉토리

• 서버가 리소스의 URI를 생성하고 관리

• 여기서 컬렉션은 /members

👆 HTTP API - 스토어

• PUT 기반 등록

• 예) 정적 컨텐츠 관리, 원격 파일 관리

파일 관리 시스템 API 설계

PUT - 신규 자원 등록 특징

1. 클라이언트가 리소스 URI를 알고 있어야 한다.

• 파일 등록 /files/{filename} -> PUT

• PUT /files/star.jpg

2. 클라이언트가 직접 리소스의 URI를 지정한다.

3. 스토어(Store)

• 클라이언트가 관리하는 리소스 저장소

• 클라이언트가 리소스의 URI를 알고 관리

• 여기서 스토어는 /files

🤟 HTML FORM 사용

• 웹 페이지 회원 관리

• GET, POST만 지원해서 제약이 있다.

• AJAX 같은 기술을 사용해서 해결 가능 -> 회원 API 참고

• 여기서는 순수 HTML, HTML FORM 이야기

API 설계

1. 등록의 경우 POST, GET를 같은 경로로 맞춰주지 않고 새로운 경로를 쓰면 서버에 문제가 생겨 POST의 최종 결과를 회원 등록 폼으로 보내야 할 때 못 돌아가기 때문에 같은 경로 맞추는 게 더 좋다.

2. 컨트롤 URI

• GET, POST만 지원하므로 제약이 있음

• 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용

• POST의 /new, /edit, /delete가 컨트롤 URI

• HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)

• 최대한 사용하지 말고 대체제로만 생각하자

정리

1. HTTP API - 컬렉션

• POST 기반 등록

• 서버가 리소스 URI 결정

2. HTTP API - 스토어

• PUT 기반 등록

• 클라이언트가 리소스 URI 결정

3. HTML FORM 사용

• 순수 HTML + HTML form 사용

• GET, POST만 지원

참고하면 좋은 URI 설계 개념

1. 문서(document)

• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)

• 예) /members/100, /files/star.jpg

2. 컬렉션(collection)

• 서버가 관리하는 리소스 디렉터리

• 서버가 리소스의 URI를 생성하고 관리

• 예) /members

3. 스토어(store)

• 클라이언트가 관리하는 자원 저장소

• 클라이언트가 리소스의 URI를 알고 관리

• 예) /files

4. 컨트롤러(controller), 컨트롤 URI

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행

• 동사를 직접 사용

• 예) /members/{id}/delete