HTTP 메서드 활용

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

클라이언트에서 서버로 데이터를 전송하는 방식은 크게 두 가지

• 쿼리 파라미터를 통한 데이터 전송
  • GET
  • 주로 정렬 필터(검색어)
• 메세지 바디를 통한 데이터 전송
  • POST, PUT, PATCH

클라이언트에서 서버로 데이터를 전송하는 4가지 상황

1. 정적 데이터 조회

• 단순히 GET으로 정적 데이터(리소스) 조회

 

2. 동적 데이터 조회

• GET으로 조회하면서 쿼리 파라미터로 데이터 전달
• EX) 검색, 게시판 목록에서 정렬 필터가 쿼리 파라미터로 전달

 

3. HTML Form 데이터 전송

• HTML Form - POST 전송
• Form의 submit 버튼을 누르면 웹브라우저가 HTTP 메시지를 생성함
• Content-Type : application/x-www.form-urlencoded 사용
  • form의 내용을 메세지 바디로 전송(key=value, 쿼리 파라미터 형식)
  • 전송 데이터 url encoding 처리 (abc김 = abc%EA%B9%80)

• HTML Form - GET 전송

• HTML Form - multpart/form-data
• 파일 업로드 같은 바이너리 데이터 전송 시 사용

 

4. HTTP API 데이터 전송

• GET : 조회, 쿼리 파라미터로 데이터 전송
• POST, PUT, PATCH : 메시지 바디를 통해 데이터 전송
• 서버 TO 서버, 앱 클라이언트, 웹 클라이언트(Form 전송 대신 자바 스크립트를 통한 통신) - 대부분 API를 사용
• Content-Type : application/json을 주로 사용

HTTP API 설계 예시

API 설계 - POST 기반 등록

ex) 회원 관리 시스템의 경우

• 회원 목록 /members → GET
• 회원 등록 /members → POST
• 회원 조회 /members/{id} → GET
• 회원 수정 /members/{id} → PATCH, PUT, POST
  • PUT은 개념적으로 리소스를 대체하는 것, 수정은 PATCH 혹은 POST가 좋음
  • PUT은 리소스를 완전히 덮어씌울때 유용(게시글 등)
• 회원 삭제 /members/{id} → DELETE

 

POST 기반 등록 특징

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

• 회원 등록 URI : /members (POST)

서버가 새로 등록된 리소스의 URI를 정한다.

• HTTP/1.1 201 Created Location: /members/100

컬렉션(Collection)

• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 정하고 관리
• 여기서 컬렉션은 /members

 

API 설계 - PUT 기반 등록

ex) 파일 관리 시스템의 경우

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

 

PUT 기반 등록 특징

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

클라이언트가 리소스 URI를 알고 있어야 한다. 

• 파일 등록 /files/{filename} → PUT
• PUT /files/star.jpg

스토어(Store)

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

 

참고하면 좋은 URI 설계 개념

URI 설계의 좋은 Practice를 모아 정리해둔것

https://restfulapi.net/resource-naming 

REST API - URL Naming Conventions

• 문서(document)
  • 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
  • 예) /members/100, /files/star.jpg
• 컬렉션(collection)
  • 서버가 관리하는 리소스 디렉터리
  • 서버가 리소스의 URI를 생성하고 관리
  • 예) /members
• 스토어(store)
  • 클라이언트가 관리하는 자원 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 예) /files
• 컨트롤러(controller), 컨트롤 URI
  • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
  • 최대한 리소스를 문서, 컬렉션, 스토어로, 행위는 메서드로 표현하고 안되면 컨트롤러 사용
  • 동사를 직접 사용
  • 예) /members/{id}/edit