5. HTTP 메서드 활용

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

데이터 전달 방식

• 쿼리 파라미터
  • GET
  • 정렬 필터 (검색어)
• 메시지 바디
  • POST, PUT, PATCH
  • 회원가입, 상품 주문, 리소스 등록 및 변경

정적 데이터 조회

쿼리 파라미터 미사용

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

• 조회는 GET 사용

• 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 조회 가능

  

동적 데이터 조회

쿼리 파라미터 사용

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

HTML Form 데이터 전송

Content-Type: application/x-www-form-urlencoded
username=kim&age=20 메시지 바디에 포함
=> 쿼리 파라미터랑 비슷한 형태

쿼리 파라미터에 username과 age를 포함
주의! 위의 사진과 같이 SAVE에 사용하면 안된다. GET은 조회에만 사용

multipart/form-data : 파일(Binary Data) 전송에서 사용, 경계를 스스로 생성해서 잘라줌

정리

• HTML Form submit시 POST
  ex. 회원 가입, 상품 주문, 데이터 변경
• Content-Type: application/x-www-form-urlencoded 사용
  • 메시지 바디를 통해서 전송 (Key=Value, 쿼리 파라미터)
  • url encoded 처리 -> abc김 = abc%EA%B9%80
• HTML Form은 GET도 가능 (조회할 때만 쓰고, 쿼리 파라미터 형식)
• Content-Type: mutipart/form-data
  • 파일 업로드 같은 바이너리 데이터 전송시 사용
  • 다른 종류의 여러 파일과 폼의 내용을 함께 전송할 수 있음
• HTML Form 전송은 GET, POST만 지원

HTTP API 데이터 전송

• 서버 to 서버
• 앱 클라이언트
• 웹 클라이언트 (Ajax)
• Content-Type: application/json (TEXT, XML, JSON 등등..)

2. HTTP API 설계 예시

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

회원 관리 시스템

API 설계 - POST 기반 등록

• 회원 목록 /members : GET
• 회원 등록 /members : POST
• 회원 조회 /members/{id} : GET
• 회원 수정 /members/{id} : PATCH(부분 수정), PUT(완전히 덮어버림), POST
• 회원 삭제 /members/{id} : DELETE

POST - 신규 자원 등록 특징

• 클라이언트는 등록될 리소스 URI를 모른다
  • 회원 데이터를 서버에 던지면 서버가 식별 후 알아서 만들어줌
• 서버가 새로 등록된 리소스 URI를 생성
  • HTTP/1.1 201 Created
    Location: /members/100

컬렉션(Collection)

• 서버가 관리하는 리소스 디렉토리
• 서버가 리소스의 URI를 생성하고 관리
• 여기서 컬렉션은 /members를 의미

API 설계 - PUT 기반 등록

• 파일 목록 /files : GET
• 파일 조회 /files/{filename} : GET
• 파일 등록 /files/{filename} : PUT
  • 클라이언트가 파일 name을 알고 있으므로 PUT
• 파일 삭제 /files/{filename} : DELETE
• 파일 대량 등록 /files : POST
  • 등록을 PUT을 쓰기 때문에 임의로 등록한 것

PUT - 신규 자원 등록 특징

• 클라이언트가 리소스 URI를 알고 있어야 한다.
  • 파일 등록시 PUT (/files/{filename})
  • ex. PUT /files/star.jpg
• 클라이언트가 직접 리소스의 URI를 지정

스토어(Store)

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

HTML FORM 사용

• HTML FORM : GET, POST만 지원 (제약 존재)
• AJAX같은 기술을 사용해서 해결이 가능

API 설계

• 회원 목록 /members : GET
• 회원 등록 폼 /members/new : GET
• 회원 등록 /members/new, /members : POST
• 회원 조회 /members/{id} : GET
• 회원 수정 폼 /members/{id}/edit : GET
• 회원 수정 /members/{id}/edit, /members/{id} : POST
• 회원 삭제 /members/{id}/delete : POST
  • DELETE를 사용할 수 없으므로 컨트롤 URI 사용

등록 폼의 URI와 등록의 URI을 맞추는 것이 validation 문제 발생 시 유리
(수정 폼과 수정도 마찬가지)

컨트롤 URI

• GET, POST만 지원하므로 제약 존재
• 이런 제약 해결을 위해 동사로 된 리소스 경로 사용
• POST의 /new, /edit, /delete가 컨트롤 URI의 예시
• HTTP 메서드로 해결하기 애매한 경우 사용 (HTTP API도 포함)

정리

문서 (Document)

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

컬렉션 (Collection)

• 서버가 관리하는 리소스 디렉토리
• 서버가 리소스의 URI 생성 및 관리
  ex. /members

스토어 (Store)

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

컨트롤러(Controller), 컨트롤 URI

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

리소스 : 주문 (order)
리소스만 가지고 설계
리소스에 복수형으로 붙이기
/orders/주문번호
이것만 가지고 해결이 안된다
-> 컨트롤 URI로 해결하자

URI 설계 개념 : https://restfulapi.net/resource-naming