클라이언트에서 서버로 데이터 전송
데이터 전달 방식은 크게 2가지이다.
1. 쿼리 파라미터를 통한 데이터 전송
- GET
- 주로 정렬 필터(검색어)
2. 메세지 바디를 통한 데이터 전송
- POST, PUT, PATCH
- 회원 가입, 상품주문, 리소스 등록, 리소스 변경
4가지 상황
1. 정적 데이터 조회
- 이미지, 정적 텍스트 문서
- 조회는 GET 사용
- 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회 가능
2. 동적 데이터 조회
- 검색, 게시판 목록에서 정렬 필터(검색어)
- 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
- 조회는 GET 사용
- GET은 쿼리 파라미터 사용해서 데이터 전달
3. HTML Form을 통한 데이터 전송
웹브라우저가 form submit 버튼 누르면 http 메세지를 생성해준다
전송할 때 메서드를 POST에서 GET으로 바꿀 수 있다.
주의) GET은 조회에만 사용. 리소스 변경하는 곳에 사용 X
- HTML Form submit시 POST 전송
예를 들어 회원가입, 상품 주문, 데이터 변경
- 형식은 application/x-www-form-urlencoded 사용
form의 내용을 메세지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)
전송 데이터를 url encoding 처리
예를 들어 abc김 -> abc%EA%B9%80
- username age 뿐만 아니라 byte로 되어있는 이미지 파일까지 같이 전송해야할 때
multipart/form-data라는 형식을 사용해야한다.
다른 종류의 여러 파일과 폼의 내용을 멀티로 함께 전송 가능하다. 그래서 이름이 multipart
- 참고로 HTML Form 전송은 GET, POST만 지원한다
4. HTTP API를 통한 데이터 전송
직접 만들어서 데이터를 서버로 넘기면 된다.
- 서버 to 서버: 백엔드 시스템 통신
- 앱 클라이언트: 아이폰, 안드로이드
- 웹 클라이언트: HTML에서 Form 전송 대신 자바 스크립트를 통한 통신 (React, VueJs...)
- POST, PUT, PATCH: 메세지 바디를 통해 데이터 전송
- GET: 조회, 쿼리 파라미터로 데이터 전달
- Content-Type: application/json을 주로 사용 (사실상 표준)
HTTP API 설계 예시
회원 관리 시스템
API 설계- POST 기반 등록
- 회원 목록 /members -> GET
GET으로 멤버에 대한 데이터를 다 내려주면 된다. 만약에 회원이 백만개면 회원을 검색하는 검색어를
쿼리 파라미터로 넣도록 설계하면 된다
- 회원 등록 /members -> POST
/members 를 컬렉션이라고 하는데, 이 컬렉션에다가 데이터를 넣으면 회원이 등록되게 하는 것
- 회원 조회 /members/{id} -> GET
회원 아이디를 넣어서 단건 조회
- 회원 수정 /members/{id} -> PATCH, PUT, POST
PUT은 기존 리소스를 삭제하고 덮어버린다. PATCH는 부분 수정이 가능하다.
그래서 거의 PATCH를 사용한다. PUT은 게시글 수정할 때 쓸 수 있다.
애매할 때는 POST. POST는 무적이다
- 회원 삭제 /members/{id} -> DELETE
원하는 아이디를 삭제
신규 자원 등록 특징
- 클라이언트는 등록될 리소스의 URI를 모른다.
- 회원등록 /members -> POST
- POST /members
- POST로 데이터 등록할 때는 서버에서 보통 리소스 URI를 결정하고 만들어준다
- HTTP/1.1 201 Created Location: /members/100
- 컬렉션(Collection)
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members
HTTP API - 스토어
API 설계- PUT 기반 등록
- 파일 목록 /files -> GET
files 안의 파일들이 다 나온다
- 파일 조회 /files/{filename} -> GET
파일 단건 조회
- 파일 등록 /files/{filename} -> PUT
새로 업로드 할 파일을 등록한다. 만약에 기존에 있으면 덮어씌운다.
PUT은 파일 등록에 걸맞음
- 파일 삭제 /files/{filename} -> DELETE
- 파일 대량 등록 /files -> POST
신규 자원 등록 특징
- 클라이언트는 등록될 리소스의 URI를 알고 있어야 한다.
- 파일 등록 /files/{filename} -> PUT 파일 이름을 넣어줘야한다는 뜻! 여기서 POST와의 차이점
- PUT /files/star.jpg
- 클라이언트가 직접 리소스의 URI를 지정한다.
- HTTP/1.1 201 Created Location: /members/100
- 스토어(Store)
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files
대부분 POST를 쓰고, PUT 사용 비중은 거의 없다!
HTML FORM 사용
- 웹 페이지 회원 관리
- GET, POST만 지원해서 제약이 있음
그래서 동사로 된 리소스 경로인 컨트롤 URI를 사용한다. 예를 들어 POST의 /new, /edit, /delete
- HTTP 메서드로 해결하기 애매한 경우 사용
