HTTP 메서드

HTTP API를 만들어보자

요구사항

• 회원 정보 관리 API를 만들어라
  
  • 조회
    • 회원 목록 조회
    • 회원 조회
  • 등록
    • 회원 등록
  • 수정
    • 회원 수정
  • 삭제
    • 회원 삭제

---

API URI 설계

• Uniformed Resource Indentifier
  • 회원 목록 조회 (read-member-list)
  • 회원 조회 (read-member-by-id)
  • 회원 등록 (create-member)
  • 회원 수정 (update-member)
  • 회원 삭제 (delete-member)
• 가장 중요한 것은 리소스 식별
  • 리소스의 의미
    • 회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
    • 회원이라는 개념 자체가 리소스다.
  • 리소스를 어떻게 식별하는게 좋을까?
    • 회원이라는 리소스만 식별하면 된다.
      • 회원 리소스를 URI에 매핑
• 리소스 식별, URI 계층 구조 활용
  • 계층 구조상 상위를 컬렉션으로 보고 복수단어를 사용하는 것을 권장한다.
    • members
• 가장 중요한 것은 리소스를 식별하는 것
  • URI는 리소스만 식별
  • 리소스와 해당 리소스를 대상으로 하는 행위를 분리
• 행위는 어떻게 구분?
  • HTTP 메서드

---

HTTP 메서드

• 클라이언트가 서버에 요청을 할 때, 기대하는 행동
• 종류
  • GET : 리소스 조회
  • POST : 요청 데이터 처리. 주로 등록에 사용
  • PUT : 리소스를 대체(덮어쓰기), 해당 리소스가 없으면 생성
  • PATCH : 리소스 부분 변경
  • DELETE : 리소스 삭제
  • HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
  • OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)를 설명 (주로 CORS에서 사용)
  • CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
  • TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

---

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query를 통해서 전달

 

---

POST

• 요청 데이터를 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

 

• 요청 데이터를 어떻게 처리한다는 뜻일까?
  • HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
    • HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
  • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
    • 게시판 글쓰기, 댓글 달기
  • 서버가 아직 식별하지 않은 새 리소스 생성
    • 신규 주문 생성
  • 기존 자원에 데이터 추가
    • 한 문서 끝에 내용 추가하기
  • 정리
    • 이 리소스 URL에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함.

---

POST (정리)

1. 새 리소스 생성 (등록)
   • 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
   • 단순 데이터 생성 또는 변경을 넘어서 프로세스를 처리해야 하는 경우
     • 서버 단에서 프로세서를 처리하면서 큰 변화가 있음.
     • 예) 주문에서 결제완료 -> 배달시작 -> 배달완료
       • 단순 값 변경을 넘어 프로세스의 상태가 변경되는 경우
   • 즉, POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음.
   • Control URI
     • 기본적으로 리소스만으로 최대한 URI를 설계하되, 어쩔 수 없는 부분들은 컨트롤 URI로 설계한다.
     • POST /orders/{orderId}/start-delivery
3. 다른 메서드로 처리하기 애매한 경우
   • 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우

---

PUT

• 리소스를 완전히 대체한다 (덮어씌우기) 
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 주의 -> 수정의 경우에는 PATCH 메서드를 사용한다.

• 클라이언트가 리소스를 식별한다.
  • 클라이언트가 리소스 위치를 알고 URI를 지정한다. (POST와의 차이점)

POST

PUT

---

PATCH

• 리소스 부분 변경
• PATCH가 지원되지 않는 서버는 POST 메서드를 사용한다.

---

DELETE

• 리소스 제거