HTTP 메소드

API URI 설계

리소스 식별, URI 계층 구조 활용

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

cf) 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용을 권장한다.
ex) member -> members

리소스와 행위를 분리

가장 중요한 것은 리소스를 식별하는 것

• URI는 리소스만 식별한다.
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리한다.
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사

HTTP 메소드 종류

• GET : 리소스 조회
• POST : 요청 데이터 처리, 주로 등록에 사용
• PUT : 리소스를 대체, 해당 리소스가 없으면 생성
• PATCH : 리소스 부분 변경
• DELETE : 리소스 삭제

• HEAD : GET과 동일하지만 메시지 부분을 제외하고 상태 줄과 헤더만 반환
• OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메소드)을 설명 (주로 CQRS에서 사용)
• CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
• TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query를 통해서 전달한다.
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만 권장하지는 않는다.

POST

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

PUT

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리로스가 없으면 생성
  • 쉽게 이야기해서 덮어버린다.
• 클라이언트가 리소스를 식별한다.
  • 클라이언트가 리소스의 위치를 알고 URI를 지정한다.
  • POST와 다른점이다.

• PUT은 부분 변경이 아닌 완전히 대체이므로 주의해야한다.

PATCH

• 리소스 부분 변경

• 리소스가 완전히 대체되는 것이 아니라 부분 변경이다.

DELETE

• 리소스 제거