5.1 클라이언트에서 서버로 데이터 전송
클라이언트에서 서버로의 데이터 전달 방식 2가지
1) 쿼리 파라미터를 통한 데이터 전송
: GET
: 주로 정렬 필터 (검색어)
2) 메시지 바디를 통한 데이터 전송
: POST, PUT, PATCH
: 회원 가입, 상품 주문, 리소스 등록, 리소스 변경
클라이언트에서 서버로의 데이터 전송 4가지 상황
1) 정적 데이터 조회
: 이미지, 정적 텍스트 문서
: 쿼리 파라미터를 사용하지 않고, 리소스 경로로 단순하게 조회 (조회 GET 사용)
2) 동적 데이터 조회
: 주로 검색, 게시판 목록에서 정렬 필터(검색어)
: 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
: 조회는 GET 사용 (GET은 쿼리 파라미터 사용해서 데이터를 전달)
3) HTML Form을 통한 데이터 전송
: 회원 가입, 상품 주문, 데이터 변경
: HTML Form 전송은 GET, POST만 지원
3-1.POST 전송 - 저장하는 경우
: HTML Form submit시 POST 전송
: Content-Type: application/x-www-form-urlencoded 사용
: form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)
: 전송 데이터를 url encoding 처리 (예) abc김 -> abc%EA%B9%80)
예) 회원 가입, 상품 주문, 데이터 변경
3.2 GET 전송 - 저장하는 경우
: HTML Form은 GET 전송도 가능
3.3 GET 전송 - 조회하는 경우
3.4 파일 전송하는 경우 (multipart/form-data)
: Content-Type: multipart/form-data 사용
: 파일 업로드 같은 바이너리 데이터 전송시 사용
: 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능
4) HTTP API를 통한 데이터 전송
: 회원 가입, 상품 주문, 데이터 변경
- 서버 to 서버 (백엔드 시스템 통신)
- 앱 클라이언트 (아이폰, 안드로이드)
- 웹 클라이언트 (HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX))
예) React, VueJs 같은 웹 클라이언트와 API 통신
: POST, PUT, PATCH: 메시지 바디를 통해 데이터 전송
: GET: 조회, 쿼리 파라미터로 데이터 전달
: Content-Type: application/json을 주로 사용 (사실상 표준)
5.2 HTTP API 설계 예시
HTTP API 설계 예시 3가지
1) HTTP API - 컬렉션
: POST 기반 등록
: 서버가 리소스 URI 결정
예) 회원 관리 API 제공
2) HTTP API - 스토어
: PUT 기반 등록
: 클라이언트가 리소스 URI 결정
예) 정적 컨텐츠 관리, 원격 파일 관리
3) HTML FORM 사용
: 웹 페이지 회원 관리
: 순수 HTML + HTML form 사용
: GET, POST만 지원
예) GET, POST만 지원
1. 회원 관리 시스템 API 설계 - POST 기반 등록
1) 회원 목록 /members -> GET
2) 회원 등록 /members -> POST
3) 회원 조회 /members/{id} -> GET
4) 회원 수정 /members/{id} -> PATCH, PUT, POST
5) 회원 삭제 /members/{id} -> DELETE
1. 회원 관리 시스템 POST - 신규 자원 등록 특징
1) 서버가 새로 등록된 리소스 URI를 생성해준다.
HTTP/1.1 201 Created Location: /members/100
2) 클라이언트는 등록될 리소스의 URI를 모른다.
회원 등록 /members -> POST
[컬렉션(Collection)]
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members
2. 파일 관리 시스템 API 설계 - PUT 기반 등록
1) 파일 목록 /files -> GET
2) 파일 조회 /files/{filename} -> GET
3) 파일 등록 /files/{filename} -> PUT
4) 파일 삭제 /files/{filename} -> DELETE
5) 파일 대량 등록 /files -> POST
2. 파일 관리 시스템 PUT - 신규 자원 등록 특징
1) 클라이언트가 리소스 URI를 알고 있어야 한다.
파일 등록 /files/{filename} -> PUT
2) 클라이언트가 직접 리소스의 URI를 지정한다
[스토어(Store)]
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files
3. HTML FORM 사용
: HTML FORM은 GET, POST만 지원
: AJAX 같은 기술을 사용해서 해결 가능
: 여기서는 순수 HTML, HTML FORM
1) 회원 목록 /members -> GET
2) 회원 등록 폼 /members/new -> GET
3) 회원 등록 /members/new, /members -> POST
4) 회원 조회 /members/{id} -> GET
5) 회원 수정 폼 /members/{id}/edit -> GET
6) 회원 수정 /members/{id}/edit, /members/{id} -> POST
7) 회원 삭제 /members/{id}/delete -> POST
[컨트롤 URI]
- GET, POST만 지원하므로 제약
- 제약을 해결하기 위해 동사로 된 리소스 경로 사용
- POST의 /new, /edit, /delete가 컨트롤 URI
- HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)
참고하면 좋은 URI 설계 개념
1) 문서(document)
: 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
예) /members/100, /files/star.jpg
2) 컬렉션(collection)
: 서버가 관리하는 리소스 디렉터리
: 서버가 리소스의 URI를 생성하고 관리
예) /members
3) 스토어(store)
: 클라이언트가 관리하는 자원 저장소
: 클라이언트가 리소스의 URI를 알고 관리
예) /files
4) 컨트롤러(controller), 컨트롤 URI
: 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
: 동사를 직접 사용
예) /members/{id}/delete
'HTTP 웹 기본 지식' 카테고리의 다른 글
[HTTP 웹 기본 지식] 섹션 6. HTTP 상태코드 (0) | 2023.07.08 |
---|---|
[HTTP 웹 기본 지식] 섹션 4. HTTP 메서드 (0) | 2023.07.01 |
[HTTP 웹 기본 지식] 섹션 3. HTTP 기본 (0) | 2023.07.01 |
[HTTP 웹 기본 지식] 섹션 2. URI와 웹 브라우저 요청 흐름 (0) | 2023.07.01 |
[HTTP 웹 기본 지식] 섹션 1. 인터넷 네트워크 (0) | 2023.07.01 |