HTTP 메서드 활용

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

 

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

- GET 

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

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

- POST, PUT, PATCH 

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

 

---

1) 정적 데이터 조회

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

- 조회는 GET 사용

- 정적 데이터는 일반적으로 쿼리 파라미터 없이 단순하게 조회 가능.

 

2) 동적 데이터 조회

- 주로 검색, 게시판 목록에서 정렬 필터 (검색어) : 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용

- 조회는 GET 사용

- 쿼리 파라미터 사용해서 데이터를 전달.

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

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

- GET, POST만 지원.

- HTTP 바디에 키-밸류(쿼리 파라미터 형식)로 데이터를 넣고 넘긴다. 

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

- 전송 데이터를 url encoding 처리

 

- 데이터를 쿼리 파라미터에 넣고 넘긴다. > 리소스를 변경할 때에는 사용할 수 없다. 조회 시에만 사용~!

- 파일 전송 시 multipart/form-data를 사용한다.

- 여러 컨텐츠 타입에 대한 데이터를 보낼 수 있다. (주로 파일 업로드 같은 바이너리 데이터를 전송할 때)

 

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

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

- 서버 to 서버 : 백엔드 시스템 통신

- 앱 클라이언트 : 아이폰, 안드로이드

- 웹 클라이언트 : HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용 (AJAX)

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

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

 

 

2. HTTP API 설계 예시

1) HTTP API - 컬렉션 : POST 기반 등록

- 회원 관리 API 제공

• 회원 목록 GET /members
• 회원 등록 POST /members
• 회원 조회 GET /members/{id}
• 회원 수정 PATCH, PUT, POST /members/{id}
• 회원 삭제 DELETE /members/{id}

- POST 기반 등록 시 : 클라이언트는 등록될 리소스의 URI를 모른다. -> 서버가 새로 등록된 리소스 URI를 등록해준다. 

- 컬렉션 (Collection) : 서버가 관리하는 리소스 디렉터리. 서버가 리소스의 URI를 생성하고 관리한다. 여기서 컬렉션은 /members 

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

 

2) HTTP API - 스토어 : PUT 기반 등록 (정적 컨텐츠 관리, 원격 파일 관리)

- 파일 관리 시스템

• 파일 목록 GET /files
• 파일 조회 GET /files/{filename}
• 파일 등록 PUT /files/{filename}
• 파일 삭제 DELETE /files/{filename}
• 파일 대량 등록 POST /files

- PUT 기반 등록 시 : 클라이언트가 리소스 URI를 알고 있어야 한다. -> 클라이언트가 직접 리소스의 URI를 지정한다. 

- 스토어 (Store) : 클라이언트가 관리하는 리소스 저장소. 클라이언트가 리소스의 URI를 알고 관리. 여기서 스토어는 /files

• 파일 등록 PUT /files/star.jpg 

** 대부분 POST 기반의 신규 자원 등록을 쓴다. 

 

3) HTML FORM 사용 :

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

- AJAX 같은 기술을 사용해서 해결 가능...하지만 여기서는 순수 HTML, HTML FORM을 말한다.

- 웹 페이지 회원 관리 

• 회원 목록 GET /members
• 회원 등록 폼 GET /members/new
• 회원 등록 POST /members/new, /members (둘다 가능하긴 함)
• 회원 조회 GET /members/{id}
• 회원 수정 폼 GET /members/{id}/edit
• 회원 수정 POST /members/{id}/edit, /members/{id}
• 회원 삭제 POST /members/{id}/delete

- 컨트롤 URI : GET, POST만 지원하므로 제약이 있는데, 이를 해결하기 위해 동사로 된 리소스 경로를 사용한다. (/new, /edit, /delete) -> 이런 것들이 컨트롤 URI임. (HTTP 메서드로 해결하기 애매한 경우에 사용한다.)

 

 

** 참고 **

- 문서(document)

• 단일 개념 (파일 하나, 객체 인스턴스, 데이터베이스 row)
• ex) /members/100, /files/star.jpg

- 컬렉션 (collection)

• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리
• ex) /members

- 스토어 (store)

• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• ex) /files

- 컨트롤러 (controller), 컨트롤 URI

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
• 동사를 직접 사용.
• ex) /members/{id}/delete

 

 

 

 

---

** 해당 내용은 김영한님의 강의를 수강하며 정리한 것입니다.

https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard

모든 개발자를 위한 HTTP 웹 기본 지식 강의 | 김영한 - 인프런

 

 

[사담 : 여태까지 URI를 설계하며 생각했던 것들에 대한 개념을 다시 배우는 느낌이었다. 컬렉션, 스토어와 같은 개념을 제대로 알지는 않았지만, 어찌저찌 API를 설계하면서 고려했던 것들이 이런 개념으로 묶여있었구나.라는 깨달음! 또, 어쩔 수 없이 컨트롤 URI 방식으로 선택했던 적이 있었는데, 이때 뭔가 잘못하고 있나라는 고민을 했다. 근데 결국은 필요한 개념이었다는 것. 복잡한 환경에서는 깔끔하게 설계할 수 없는 상황이 있는데 이때는 차라리 동사를 직접 사용하는 컨트롤 URI 방법을 쓸 수 밖에 없다! 결국 개념을 알면서 고려하며 설계하는 것이 중요함을 깨달았다. ]