- 클라이언트에서 서버로 데이터 전송
- HTTP API 설계 예시
클라이언트에서 서버로 데이터 전송
데이터를 전달하는 방식은 크게 두가지 이다
- 쿼리 파라미터를 통한 데이터 전송
- GET 사용, 주로 정렬 필터
- 메세지 바디를 통한 데이터 전송
- POST, PUT, PATCH 사용.
- 회원가입, 상품 등록 등 리소스 변경시 사용.
클라리언트에서 서버로 데이터를 전송하는 법
1. 정적 데이터 조회
GET /static/star.jpg
- 단순히 이미지, 정적 텍스트 문서를 조회할 때 사용.
- GET 사용
- 정적 데이터는 일반적으로 쿼리 파라미터 없이 단순 리소스 경로로 조회 가능.
2. 동적 데이터 조회
이런식으로 뒤에 쿼리문을 붙여서 사용
- 주로 검색, 게시판 목록에서 정렬 필터(검색어)
- 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
- 조회는 GET 사용
- GET은 쿼리 파라미터 사용해서 데이터를 전달 →메세지 바디를 사용할 수 있느나 아직 지원하지 않는 곳이 더 많음.
3. HTML Form을 통한 데이터 전송
<form action="/save" method="post"> <input type="text" name="username" /> <input type="text" name="age" /> <button type="submit">전송</button>
- HTML Form submit시 POST 전송
- 예시) 회원 가입, 상품 주문, 데이터 변경
- Content-Type : application/x-www-form-urlencoded 사용
- form의 내용을 메세지 바디를 통해서 전송 (key=value, 쿼리 파라미터 형식)
- 전송 데이터를 url encoding 처리 예시) abc김 → abc%EA%B9%80
- HTML Form은 GET, POST만 전송 가능
- Content-Type : multipart/form-data
- 파일 업로드 같은 바이너리 데이터 전송시 사용
- 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능 (그래서 이름이 multipart)
4. HTTP API를 통한 데이터 전송
POST /members HTTP/1.1
Content-Type: application/json
{
"username": "young",
"age": 20
}
- 서버 to 서버 (백엔드 시스템 통신)
- 앱 클라이언트 (아이폰, 안드로이드)
- 웹 클라이언트
- HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용 (AJAX) 예) React, VueJs 같은 웹 클라이언트와 API 통신
- HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용 (AJAX) 예) React, VueJs 같은 웹 클라이언트와 API 통신
- POST, PUT, PATCH : 메세지 바디를 통해 데이터 전송
- GET : 조회, 쿼리 파라미터로 데이터 전달.
- Content-Type : application/json을 주로 사용 (사실상 표준) 그 외에도 TEXT,XML 등등이 있음.
HTTP 설계 예시
HTTP API - 컬렉션
- POST기반 등록 (ex 외원 관리 API 제공)
- 회원 관리 시스템
- 회원 목록 /members → GET
- 회원 등록 /members → POST → 여기가 POST 기반
- 회원 조회 /members/{id} → GET
- 회원 수정 /members/{id} → PATCH,PUT,POST
(수정을 할때는 원하는 데이터만 바꾸는 PATCH를 사용하는게 좋다.) - 회원 삭제 /members/{id} → DELETE
- 클라이언트는 등록될 리소스의 URI를 모른다. POST /members → /members로 등록을 해야하기 때문에 id값 모름.
- 서버가 새로 등록된 리소스 URI를 생성해준다. /members/100 : 서버가 새로운 리소스를 등록하면서 100이라는 id값을 부여하며 url 생성
컬렉션 (Collection) : 위와 같은 관리방법을 컬렉션 이라고 함.
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members
HTTP API - 스토어
- PUT 기반 등록 (ex 정적 컨텐스 관리, 원격 파일 관리)
- 파일 관리 시스템
- 파일 목록 /files → GET
- 파일 조회 /files/{filename} → GET
- 파일 등록 /files/{filename} → PUT → 등록에 PUT 사용.
- 파일 삭제 /files/{filename} → DELETE
- 파일 대량 목록 /files → POST (임의로 정한 POST 역할)
- 클라이언트가 리소스 URI를 알고 있어야 한다.
- PUT /files/star.jpg → 클라이언트가 uri를 지정해서 보내줌.
- 클라이언트가 직접 리소스의 URI를 지정.
스토어(Stroe) : 위와 같은 관리방법을 스토어라고 함
- 클라이언트가 관리하는 리소스 저장소
- 클라이어트가 리소스의 URI를 알고 관리.
- 여기서 스토어는 /files
대부분 POST 기반의 컬렉션을 사용함 (PUT 기반의 스토어는 거의 사용하지 않음)
HTML FORM 사용
- GET, POST만 지원하므로 제약이 있음.(물론 AJAX 같은 기술을 쓰면 해결할 수 있지만 여기서는 순수한 HTML FORM 만 생각)
- 웹 페이지 회원 관리
- 회원 목록 /members → GET
- 회원 등록 폼 /members/new → GET
- 회원 등록 /members/new, members → POST → GET과 POST의 일치를 위해 같은 uri를 사용해도 되고, 콜렉션 방법처럼 그냥 /members만 사용해도 괜찮다. (스타일 차리)
- 회원 조회 /members/{id} ⇒ GET
- 회원 수정 폼 /members/{id}/edit ⇒ GET
- 회원 수정 /members/{id}/edit, /members/{id} ⇒ POST
- 회원 삭제 /members/{id}/delete ⇒ POST → delete라는 메서드를 못사용하기 때문에 uri의 경로에 delete 표현
- 컨트롤 URI
- GET, POST만 지원하므로 제약이 있어, 해결을 위해 동사로 된 리소스 경로 사용.
- POST의 /new, /edit, /delete가 컨트롤 URI
- HTTP 메서드로 해결하기 애매한 경우 사용 (HTTP API 포함)
-> 실무에서도 컨트롤 URI 많이 사용함. (단, 정말 어쩔 수 없는 경우에만 사용해야함. 최대한 메서드로 대체할 수 있으면 대체)
출처
https://www.inflearn.com/course/http-웹-네트워크
https://developer.mozilla.org/ko/docs/Web/HTTP
