[모든 개발자들을 위한 HTTP 웹 기본 지식] #5. HTTP 메서드 활용

[Pracrobo]

HTTP 메서드 활용

• 클라이언트에서 서버로 데이터 전송
• HTTP API 설계 예시

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

데이터 전달 방식은 2가지

• 쿼리 파라미터를 통한 데이터 전송
  • GET
  • 주로 정렬 필터(검색어)
• 메세지 바디를 통한 데이터 전송
  • POST, PUT, PATCH
  • 회원가입, 주문, 리소스 등록, 리소스 변경

4가지 상황

1. 정적 데이터 조회

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

2. 동적 데이터 조회

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

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

   • 회원가입, 상품주문, 데이터변경
   • Multipart form data : binary data 쓸 때 사용
   • HTML Form submit 에서 POST 전송
     • 회원 가입, 상품 주문, 데이터 변경
   • Content-typem : appliactaon/x-www-form-urlencoded 사용
   • 전송데이터를 url encoding처리
     • ex) abc김 >> abc%EA%B9%80
   • HTML Form 은 GET 전송도 가능
   • Content-Type : multipart/form-data
     • 파일 업로드 같은 바이너리 데이터 전송시 사용
     • 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능(그래서 이름이 multipart)

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

4. HTTP API를 통한 데이터 전송
   • 회원 가입, 상품 주문, 데이터 변경
   • 서버 to 서버(백엔드 시스템 통신), 앱 클라이언트(안드로이드, 아이폰), 웹 클라이언트(Ajax)
   • POST, PUT, PATCH : 메세지 바디를 통해 데이터 전송
   • GET : 조회, 쿼리 파라미터로 데이터 전달
   • Content-Type : applicaton/json을 주로 사용(사실상 표준)
     • TEXT, XML, JSON 등
       

HTTP API 설계 예시

• HTTP API : 컬렉션
  • POST 기반 등록
  • ex) 회원 관리 API 제공
• HTTP API : 스토어
  • PUT 기반 등록
  • ex) 정적 컨텐츠 관리, 원격 파일 관리
• HTML FORM 사용
  • 웹페이지 회원 관리
  • GET, POST 만 지원

회원 관리 시스템

API 설계 : POST 기반 등록

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

POST : 신규 자원 등록 특징

클라이언트는 등록될 리소스의 URI를 모른다.

• 회원등록 /members : POST
• POST /members
  서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1 201 Created
  • Location : /members/100
    컬렉션(Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

API 설계 : PUT 기반 등록

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

PUT : 신규 자원 등록 특징

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

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

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

HTML FORM 사용

• GET, POST 만 지원
• Ajax 같은 기술을 사용해서 해결 가능 : 회원 API 참고
• 여기서는 순수 HTML, HTML FORM 이야기
• GET, POST 만 지원하므로 제약이 있음
• 컨트롤 URI
  • GET, POST만 지원하므로 제약이 있음
  • 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST 의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)
    

정리

참고하면 좋은 URI 설계 개념

• 문서(document)

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

• 컬렉션(collection)

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

• 스토어(store)

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

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

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

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

출처

• 김영한 강사님 HTTP 강의