HTTP 메서드 활용 정리 (API, URI 설계)

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

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

* 본 포스팅은 인프런 김영한 강사님의 모든 개발자를 위한 HTTP 웹 기본 지식을 들으며 적은 강의노트입니다. *

 

 

클라이언트에서 서버로 데이터 전달 방식

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

- GET

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

 

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

- POST, PUT, PATCH

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

 

HTML Form 데이터 전송

1. HTML Form submit시 POST 전송

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

 

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

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

 - 전송 데이터를 url encoding 처리

 예) abc김 -> abc%EA%B9%80

 

3. HTML Form은 GET 전송도 가능

 - 하지만 많은 서버에서 지원하지 않아서 거의 사용하지 않는다.

 

4. Content-Type: multipart/form-data

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

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

 

참고: HTML Form 전송은 GET, POST만 지원함

 

HTTP API 데이터 전송

1. 서버 to 서버

 - 백엔드 시스템 통신

 

2. 앱 클라이언트

 - 아이폰, 안드로이드

 

3. 웹 클라이언트

 - HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용 (AJAX)

  예) React, Vue.js 같은 웹 클라이언트와 API 통신

 

4. POST, PUT, PATCH: 메세지 바디를 통해 데이터 전송

 

5. GET: 조회, 쿼리 파라미터로 데이터 전달

 

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

 - TEXT, XML, JSON 등등

 

HTTP API 설계 예시

1. HTTP API - 컬렉션

 - POST 기반 등록

 예) 회원 관리 API 제공

 

2. HTTP API - 스토어

 - PUT 기반 등록

 예) 정적 컨텐츠 관리, 원격 파일 관리

 

3. HTML FORM 사용

 - 웹 페이지 회원 관리

 - GET, POST만 지원

 

회원 관리 시스템 API 설계 - POST 기반 등록

- 회원 목록 /members -> GET

- 회원 등록 /members -> POST

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

- 회원 수정 /members/{id} -> PATCH, PUT, POST

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

 

파일 관리 시스템 API 설계 - PUT 기반 등록

- 파일 목록 /files -> GET

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

- 파일 등록 /files/{filename} -> PUT

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

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

 

 

Rest API에 관한 사이트

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