재학습 5일차_HTTP 메서드 활용

# HTTP 메서드 활용

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

데이터 전달 방식은 크게 2가지

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

• 주로 GET, 정렬 필터(검색어) 에서 사용.

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

• POST, PUT, PATCH 등
• 회원가입, 상품 주문,리소스 등록, 리소스 변경 등에 사용.

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

1. 정적 데이터 조회

• 이미지, 정적 텍스트 문서 등 조회는 GET 사용.
• 정적 데이터는 일반적으로 쿼리 파라미터 없이, 리소스 경로로 단순하게 조회 가능.

2. 동적 데이터 조회

• 쿼리 파라미터 사용.(GET /search?q=hello&hl=ko)
• 주로 검색, 게시판 목록에서 정렬 필터(검색어)에 사용.
• 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용.
• 조회는 GET 사용. (GET은 쿼리 파라미터를 사용해 데이터를 전달)

3. HTML Form 을 이용한 데이터 전송

• POST 전송 - 저장
• HTML Form submit 시 POST 전송. (회원가입, 상품주문, 데이터 변경 등에 사용)
• Content-Type : application/x-www-form-rulencoded 사용.

form 의 내용을 메시지 바디를 통해 전송(key=value, 쿼리 파라미터 형식)

전송 데이터를 url encoding 처리 
예) aaa김 -> aaa%EA%B9%80

• HTML Form은 GET 전송도 가능 (하지만 저장 등에는 POST 사용)
• Content-Type : multipart/form-data

파일 업로드 같은 바이너리 데이터 전송 시 사용.

다른 종류의 여러파일과 폼 내용을 함께전송 가능 (그래서 이름이 multipart)

• 참고사항 : HTML Form 전송은 GET, POST만 지원.

4. HTTP API 전송

• 서버 to 서버로 백엔드 시스템 통신 시 사용.
• 앱 클라이언트에서 전송 시에도 사용 (안드로이드, 아이폰)
• 웹 클라이언트 : HTML에서 Form 전송 대시 자바 스크립트를 통한통신에 사용 (AJAX 통신) - 예) React, VueJs 같은 웹 클라이언트와 API 통신
• 메시지 바디를 통한 데이터 전송 (POST / PUT / PATCH)
• GET : 조회, 쿼리 파라미터를 데이터로 전달
• Content-Type : application/json을 주로 사용 (사실상 표준) - TEXT, XML(과거에 많이 사용), JSON 등등

## HTTP API 설계 예시

1. HTTP API (컬렉션)

• POST 기반 등록
• 예 : 회원 관리 API 제공

회원 관리 시스템 (POST 기반 등록 - 컬렉션) : 대부분의 실무에서 사용.

• API 설계 - POST 기반 등록.

회원 목록 : /members -> GET

회원 등록 : /members -> POST

회원 조회 : /members/{id} -> GET

회원 수정 : /members/{id} -> PATCH / PUT / POST
(PATCH : 부분 수정 / PUT : 완전히 덮어쓰기)
(PATCH 사용 권장, PUT은 게시판 수정 등에 사용)

회원 삭제 : /members/{id} -> DELETE

• POST - 신규 자원 등록 특징

클라이언트는 등록될 리소스의 URI를 모름. 
- 회원 등록 /members -> POST
- POST /members

서버가 새로 등록된리소스 URI를 생성해준다.
- HTTP/1.1 201 Created
  Location: /members/100


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

2. HTTP API (스토어)

• PUT 기반 등록
• 예 : 정적 컨텐츠 관리, 원격 파일 관리

 

파일 관리 시스템 (PUT 기반 등록 - 스토어)

• API 설계 - PUT 기반 등록

파일 목록 : /files -> GET

파일 조회 : /files/{filename} -> GET

파일 등록 : /files/{filename} -> PUT
(PUT : 없으면 새로 생성, 있으면 덮어쓰기)

파일 삭제 : /files/{filename} -> DELETE

파일 대량 등록 : /files -> POST

• PUT - 신규 자원 등록 특징

클라이언트가리소스 URI 를 알고 있어야 함
- 파일등록 : /files/{filename} -> PUT
- PUT /files/star.jpg

클라이언트가 직접 리소스의 URI를 지정한다.


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

3. HTML FORM 사용 (컨트롤 URI)

• HTML FORM은 GET, POST만 지원 (제약 존재)
• AJAX같은 기술을 사용해서해결 가능 -> 회원 API 참고.

회원 목록 : /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 포함)

정리.

• HTTP API - 컬렉션 : POST 기반 등록, 서버가 리소스 URI 결정.
• HTTP API - 스토어 : PUT 기반 등록, 클라이언트가 리소스 URI 결정.
• HTML FORM 사용 : 순수HTML + HTML FORM 사용, GET 과 POST 만 지원.

참고하면 좋은 URI설계 개념 (중요 팁!) 

• https://restfulapi.net/resource-naming/

REST Resource Naming Guide

1. 문서 (document)

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

2. 컬렉션(collection)

• 서버가관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성, 관리
• 예 : /members

3. 스토어 (store)

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

4. 컨트롤러(controller), 컨트롤 URI (최후의 수단)

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