1. 클라이언트에서 서버로 데이터 전송
데이터 전달 방식
a. 쿼리 파라미터를 통한 데이터 전송
- GET 메서드 사용
- 주로 정렬 필터(검색어) ex. www.google.com/q=hello
b. 메시지 바디를 통한 데이터 전송
- POST, PUT, PATCH 메서드 사용
- 회원 가입(회원 정보), 상품 주문(상품 정보), 리소스 등록 및 변경(리소스 정보) 등
4가지 상황
a. 정적 데이터 조회
이미지, 정적 텍스트 문서
- 조회는 GET 사용
- 정적 테이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회 가능
b. 동적 데이터 조회
주로 검색, 게시판 목록에서 정렬 필터(검색어)
- 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
- 조회는 GET 사용
- GET은 쿼리 파라미터를 사용해 데이터 전달 (메시지 바디 이용 X)
c. HTML Form을 통한 데이터 전송
HTML Form submit 시 POST 전송 ex. 회원 가입, 상품 주문, 데이터 변경
- Content-Type: application/x-www-form-urlencoded 사용
- form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)
- 전송 데이터를 URL encoding 처리 ex. abc김 -> abc%EA%B9%80
HTML Form은 GET 전송도 가능 (저장 X; 조회)
- HTML Form 내용을 URI에 넣어 전송 (쿼리 파라미터로 전송)
- 리소스 변경이 발생하는 곳에서 사용하면 안 됨
Content-Type: multipart/form-data 사용
- 파일 업로드 같은 바이너리 데이터 전송 시 사용 ex. 이미지 파일, 동영상 파일
- 다른 종류의 여러 파일과 폼의 내용을 함께 전송할 수 있음
- 경계를 나타내는 boundary 표시로 잘라서 전달함
참고: HTML Form 전송은 GET과 POST만 지원함 (PUT, DELETE 등 사용 불가)
d. HTTP API를 통한 데이터 전송
회원 가입, 상품 주문, 데이터 변경 / 서버 to 서버, 앱 클라이언트, 웹 클라이언트(Ajax)
서버 to 서버
- 백엔드 시스템 통신 (HTML 같은 것 없이 기계끼리 소통)
앱 클라이언트
- 아이폰, 안드로이드
웹 클라이언트
- HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(Ajax)
- Ajax: 비동기식 자바 스크립트를 활용한 XML 전송
- ex. React, VueJs 같은 웹 클라이언트와 API 통신
POST, PUT, PATCH
- 메시지 바디를 통해 데이터 전송
GET
- 조회 (쿼리 파라미터로 데이터 전달)
Content-Type
- application/json을 주로 사용 (사실상 표준)
- TEXT, XML, JSON 등
2. HTTP API 설계 예시 - 리소스 식별에 집중하기
회원 관리 시스템 (컬렉션)
a. POST 기반 등록
| 회원 목록 | /members | GET |
| 회원 등록 | /members | POST |
| 회원 조회 | /members/{id} | GET |
| 회원 수정 | /members/{id} | PATCH, PUT, POST |
| 회원 삭제 | /members/{id} | DELETE |
회원 수정
- PATCH: 정보 일부 수정 ex. 회원 닉네임
- PUT: 정보를 완전히 대체 ex. 게시글 수정
- POST: 애매한 경우 사용
b. POST - 신규 자원 등록 특징
클라이언트는 등록될 리소스의 URI를 모름
- 회원 등록 /members (POST)
- POST /members
서버가 새로 등록된 리소스 URI를 생성해 줌
- HTTP/1.1 201 Created
- Location: /members/100 (리소스 식별자)
컬렉션(Collection)
- 서버가 관리하는 리소스 디렉터리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members
- 대부분 이 방식을 사용함 (POST 신규 자원 등록 - 컬렉션)
파일 관리 시스템 (스토어)
a. PUT 기반 등록
| 파일 목록 | /files | GET |
| 파일 조회 | /files/{filename} | GET |
| 파일 등록 | /files/{filename} | PUT |
| 파일 삭제 | /files/{filename} | DELETE |
| 파일 대량 등록 | /files | POST |
b. PUT - 신규 자원 등록 특징
클라이언트가 리소스 URI를 알고 있어야 함
- 파일 등록 /files/{filename} (PUT)
- PUT /files/star.jpg
클라이언트가 직접 리소스의 URI를 지정함
- 이미 있으면 대체하고, 없으면 새로 등록
스토어(store)
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리함
- 여기서 스토어는 /files
HTML Form 사용
GET과 POST만 지원하기 때문에 제약이 존재함
- Ajax 같은 기술을 사용해서 해결 가능 (회원 API 참고)
- 여기서는 순수 HTML과 HTML Form을 말함
- 폼과 관련된 URI를 통일하는 것이 좋음
| 회원 목록 | /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 |
컨트롤 URI
- GET과 POST만 사용하기 때문에 생기는 제약을 해결하기 위해 동사로 된 리소스 경로를 사용
- POST의 /new, /edit, /delete가 컨트롤 URI
- HTTP 메서드로 해결하기 애매한 경우에 사용함 (HTTP API 포함)
- 실무에서 자주 사용함 (정말 애매한 경우에 써야 함!)
참고하면 좋은 URI 설계 개념
a. 문서(document)
- 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스의 row)
- ex. /members/100, /files/star.jpg
b. 컬렉션(collection) - POST
- 서버가 관리하는 리소스 디렉터리
- 서버가 리소스의 URI를 생성하고 관리
- ex. /members (회원 등)
c. 스토어(store) - PUT
- 클라이언트가 관리하는 자원 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- ex. /files (파일, 게시판 등)
d. 컨트롤러(controller), 컨트롤 URI
- 문서, 컬렉션, 스토어로 해결하기 어려운 (프로세스 변경 등; 깔끔하지 않을 때) 추가 프로세스 실행
- 동사를 직접 사용
- ex. /members/{id}/delete, /orders/{id}/delivery
- 우선 리소스로 URI 설계하고 HTTP 메서드를 활용한 뒤, 해결이 안되면 컨트롤 URI로 사용하기
