HTTP 메서드

 회원 정보 관리 API를 만들라는 요청을 받았다.

• 회원 목록 조회
  • /read-member-list
• 회원 조회
  • /read-member-by-id
• 회원 등록
  • /create-member
• 회원 수정
  • /update-member
• 회원 삭제
  • /delete-member

 URI 설계에서 가장 중요한 것은 리소스 식별이다. 회원을 등록하고 수정하고 조회하는게 리소스가 아니라 회원이라는 개념 자체가 바로 리소스이다. 즉, 리소스를 식별할 때는 회원이라는 리소스만 식별하면 된다.
 처음 설계한 URI를 다시 설계해본다.

• 회원 목록 조회
  • /members
• 회원 조회
  • /members/{id}
• 회원 등록
  • /members/{id}
• 회원 수정
  • /members/{id}
• 회원 삭제
  • /members/{id}

 참고로 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용이 권장된다.
 위 URI에서 조회, 등록, 수정, 삭제의 URI가 같다. 이는 URI는 리소스만 식별하기 때문이다. 리소스와 해당 리소스를 대상으로 하는 행위를 분리해야한다.

HTTP 메서드 - GET, POST

 HTTP 메서드의 종류는 다음과 같다.

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

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음

POST

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

 POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청한다. 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다.

HTTP 메서드 - PUT, PATCH, DELETE

PUT

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
• 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점

 다음은 PUT 메서드에서 주의해야 할 점이다.

 이는 PUT 메서드는 리소스를 완전히 대체한다는 점이다.

PATCH

• 리소스 부분 변경

DELETE

• 리소스 제거

HTTP 메서드의 속성

• 안전(Safe Methods)
  • 호출해도 리소스를 변경하지 않는다.
  • 계속 호출해서, 로그 같은데 쌓여서 장애가 발생 하는 경우에서 안전은 해당 리소스만 고려한다.
• 멱등(Idempotent Methods)
  • 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
  • 멱등 메서드
    • GET: 같은 결과가 조회된다.
    • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
    • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
    • POST: 멱등이 아니다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
  • 멱등은 자동 복구 메커니즘에 활용된다.
• 캐시가능(Cacheable Methods)
  • GET, HEAD, POST, PATCH 캐시 가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용
    • POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.