HTTP 메서드 활용
1. 클라이언트에서 서버로 데이터 전송
쿼리 파라미터를 통한 데이터 전송
메시지 바디를 통한 데이터 전송
- POST, PUT, PATCH
- 회원 가입, 상품 주문, 리소스 등록 및 변경
클라이언트에서 서버로 데이터 전송 4가지 상황
- 정적 데이터 조회
- 이미지, 정적 텍스트 문서 (GET)
- 보통 따로 쿼리 파라미터 없이 리소스 경로만으로 단순하게 조회한다.
- 동적 데이터 조회
- 주로 검색, 게시판 목록에서 정렬 필터 (GET)
- 쿼리 파라미터를 사용
- HTML Form을 통한 데이터 전송
- 회원 가입, 상품 주문, 데이터 변경 (POST)
- POST로 보내면 content-type: application/x-www-form-unlencoded
(urlencoded를 보면 알겠지만, 전송 데이터를 UTF-8같은 걸로 url encoding해서 보낸다. )로 바디에 username=kim&age=20
이런식으로 오게된다.(GET의 쿼리파라미터랑 비슷한 포맷으로 바디에 담긴다.)
- 이걸 GET으로 보내면 데이터가 URL에 담겨 보내진다...GET은 조회에만 쓰자.
- HTTP API를 통한 데이터 전송
- 회원 가입, 상품주문, 데이터 변경
- Server to Server
- 앱 클라이언트
- IOS, ANDROID에서 데이터 전송할때도 자주 쓰인다.
- 웹 클라이언트(Ajax)
- form같은 HTML 기능을 통한 통신이 아니라 자바스크립트를 통한 통신을 할 때 자주 쓰인다.(Ajax 통신) react, vue에서 자주 쓴다.
- Content-Type: application/json
- 사실상 표준으로 쓰인다. 그외에 TEXT, XML등이 있긴하다.
2. HTTP API 설계 예시
회원 관리 시스템
POST - 신규 자원 등록 특징
- 클라이언트는 등록될 리소스의 URI를 모른다.
- 서버가 새로 등록된 리소스 URI를 생성해준다.
- 응답: HTTP/1.1 201 Created
Location: /members/100 이런식!
- 컬렉션
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members
-> /members에서 각종 파생 URL이 생기게 된다.
PUT - 신규 자원 등록 특징
- 클라이언트가 리소스의 URI를 알고 있어야 한다.
- 파일 등록 /files/{filename} -> PUT
- PUT /files/moon.jpg 이런식으로 리소스 이름과 위치 자체를 알아야한다!
- 스토어(store)
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files
보통 POST 기반의 컬렉션을 주로 쓴다!
- HTML FORM은 GET, POST만 지원
- AJAX 같은 기술을 이용해서 해결 가능
- 순수 HTML,HTML FORM 기준 설명하겠습니다.
- GET, POST만 써서 제약이 있다.
-> 따라서 동사로 된 리소스 경로 사용: 컨트롤 URI(/new,/edit/delete등)
좋은 API 네이밍 가이드라인: https://restfulapi.net/resource-naming/