HTTP 메서드 활용

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

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

• GET
• 주로 정렬 필터(검색어)

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

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

정적 데이터 조회

• 쿼리 파라미터 미사용
• 단순한 경로로 요청하여 응답 받음
• 이미지, 정적 텍스트 문서
• GET 사용

동적 데이터 조회

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

GET /search?q=hello&hl=ko HTTP1.1 
HOST:www.google.com/

HTML Form 데이터 전송

• POST 전송 - 저장
• GET으로도 전송 가능
  • 웹 브라우저가 쿼리스트링에 입력해줌
  • GET은 조회용이기 때문에 저장에서 사용하면 안된다.
• multipart/form-data
  • <from action”/save” method=”post” enctype=”multipart/form-data”>
  • 바이트로 되어 있는 파일을 같이 전송해야 할때 사용
• HTML Form 전송은 GET, POST만 지원

POST /member HTTP1.1 
Host:localhost:8080 
Content-Type: application/x-www-form-urlencoded  

username=kim&age=20

HTTP API 데이터 전송

• 웹 브라우저가 만들어주는 형태를 직접 만들어 전송
• 서버 to 서버
  • 백엔드 시스템 통신
• 앱 클라이언트
  • 아이폰, 안드로이드
• 웹 클라이언트
  • 자바스크립트를 통한 통신에 사용(AJAX)
  • React, VueJs 같은 웹 클라이언트와 API 통신
• POST, PUT, PATCH : 메시지 바디를 통해 데이터 전송
• GET : 조회, 쿼리 파라미터로 데이터 전달
• Content-type:application/json을 주로 사용(사실상 표준)
  • TEXT, XML, JSON 등등..

HTTP API 설계

HTTP API-컬렉션

• POST 기반 등록
• 서버가 관리하는 리소스 디렉토리
• 서버가 리소스의 URI를 생성하고 관리
• 여기서 컬렉션은 /members
• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

HTTP API-스토어

• PUT 기반
  • 파일등록 /files/{filename} -> PUT
  • PUT /files/star.jpg
• 클라이언트가 관리하는 리소스 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• 여기서 스토어는 file
• 클라이언트가 리소스의 URI를 알고 있어 직접 넘겨줘야 한다.
• 사용비중이 거의 없음

HTML FROM 사용

• GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능
• 컨트롤 URI
  • GET, POST만 지원하므로 제약이 있음
  • 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 메서드로 해결하기 애마한 경우 사용(HTTP API 포함)
  • 대체제로 사용하고 되도록 리소스만을 사용한다.

사용 예시

• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
• 회원 등록 /members/new OR /members -> POST
  • 등록 폼과 같은 URL을 쓰거나 리소스 정보만 쓴다.
  • URL을 맞춰두면 새로고침 하거나 할떄 경로값이 같아 돌아가기가 편하다.
• 회원 조회 /members/{id} -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit OR /members/{id} -> POST
• 회원 삭제 /members/{id}/delete -> POST
  • 컨트롤 URI

정리

참고하면 좋은 URI 설계 개념

• 문서(document)
  • 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
  • /members/100, /files/start.jpg
• 컬렉션(collection)
  • 서버가 관리하는 리소스 디렉터리
  • 서버가 리소스의 URI를 생성하고 관리
  • /members
• 스토어
  • 클라이언트가 관리하는 자원 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • /file
• 컨트롤러(controller), 컨트롤 URI
  • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
  • 동사를 직접 사용
  • /member/{id}/delete
  • /member/{id}/edit
• https://restfulapi.net/resource-naming 참조