[HTTP][4] HTTP 메서드

[ HTTP API를 만들어보자 ]

1. 요구사항

회원 정보 관리 API를 만들어라.

• 회원 목록 조회
• 회원 조회/등록/수정/삭제

2. API URI 설계

위의 요구사항을 API로 만들어볼 때 단순하게 생각하면 다음과 같이 설계할 수도 있다.

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

🙅🏻‍♀️ 이건 좋은 URI 설계가 아니야! 중요한 것은 리소스 식별이야!

3. API URI 설계 - 리소스 식별, URI 계층 구조 활용

지금부터 리소스에 집중하여 API URI 설계해보자!

✅ 리소스

먼저 리소스에 대해 짚고 넘어가자.
회원 조회, 회원 등록은 리소스가 아니다. 회원이라는 개념 자체가 바로 리소스다!

이 회원이라는 리소스에 집중해서, 조회/등록/삭제/변경 등 행위는 모두 배제하여 URI에 매핑시키자.

📌 URI는 리소스만 식별한다.

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

✅ API URI 설계

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

📌 참고

계층 구조상 상위를 컬렉션으로 보고 복수단어를 사용하는 것을 권장한다.
member → members

🤔 오잉 근데 회원 목록 조회를 제외하고 URI가 모두 동일한데 어떻게 구분하지?
🤸🏻‍♀️ 바로 HTTP 메서드를 통해서 구분할 수 있어!

---

[ HTTP 메서드 ]

0. HTTP 메서드 종류

✅ 주요 메서드

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

✅ 기타 메서드

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

1. GET

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

2. POST

• 새 리소스 생성(등록)
  • 서버가 아직 식별하지 않은 새 리소스 생성
• 요청 데이터 처리
  • 단순히 데이터를 생성하거나, 변경하는 것을 넘어 프로세스를 처리해야 하는 경우 사용한다.
  • 서버는 메시지 바디를 통해 들어온 데이터를 처리한다.
  • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
• 다른 메서드로 처리하기 어려운 경우
  • JSON으로 조회 데이터를 넘겨야 하는데 GET 메서드를 사용하기 어려운 경우와 같이 애매한 경우 POST를 사용한다.

3. PUT

• 리소스를 완전히 대체한다.
  • 폴더에 파일을 추가하는 것처럼, 리소스가 있으면 대체하고, 리소스가 없으면 생성한다.
• 클라이언트가 리소스를 식별한다.
  • 클라이언트가 리소스 위치를 알고 URI를 지정한다.
  • POST와의 차이점

PUT은 리소스를 완전히 대체한다.

4. PATCH

• 리소스 부분 변경
• PUT과 비슷하지만, 부분적으로만 수정하고 싶으면 PATCH를 사용한다!

+) PATCH를 지원하지 않는 곳도 있는데, 그럴 경우는 POST를 쓰면 된다.

5. DELETE

• 리소스 제거

---

[ HTTP 메서드의 속성 ]

1. 안전 (Safe Methods)

• 호출해도 리소스가 변경되지 않는 것을 안전하다라고 한다.
  • 안전한 메서드 - GET(조회만 하기 때문에 리소스가 변경되지 않음.)
  • 안전하지 않은 메서드 - POST, PUT, DELETE, PATCH
• 안전의 범위는 해당 리소스만 고려하기 때문에, 외적인 요소까지는 고려하지 않는다.
  • 예) 계속 호출해서, 로그가 쌓이는 것은 외적인 부분이므로 고려하지 않는다.
    
    

2. 멱등 (Idempotent Methods)

f(f(x)) = f(x)

• 메서드를 여러 번 호출해도 결과가 항상 똑같다!
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
  • PUT: 결과를 대체한다. 따라서 같은 요청을 여러 번 해도 최종 결과는 같다.
  • DELETE: 결과를 삭제한다. 같은 요청을 여러 번 해도 삭제된 결과는 같다.
  • POST: 멱등이 아니다. 두 번 호출하면 에러가 발생할수 있다.
• 활용
  • 자동 복구 메커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못했을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거가 된다.
• 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다.

3. 캐시 가능 (Cacheable Methods)

• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• GET, HEAD, POST, PATCH는 캐시 가능하다.
• 하지만, 실제로는 GET, HEAD 정도만 캐시로 사용한다.
  → POST, PATCH는 본문 내용까지 캐시 키로 고려해야하는데 구현이 쉽지 않다.

---

[ 📘 오늘의 TIL 정리 ]

• API URI를 설계할 때 리소스에 집중해야 한다.
  • 즉, 리소스와 행위를 분리하여 리소스는 명사, 행위는 동사로 표현한다.
• URI는 HTTP 메서드를 통해서 구분할 수 있다.
• GET은 주로 리소스 조회에 사용된다.
• POST는 새 리소스 등록이나 요청 데이터를 처리할 때 사용된다.
  • POST는 모든 동작이 가능하므로 다른 메서드로 처리하기 어려운 경우도 사용된다.
• PUT은 리소스를 대체할 때 사용된다.
  • 폴더에 파일을 추가하는 것과 비슷하다고 생각하면 된다.
  • POST와 달리 경로를 지정해주어야 한다!
• PATCH는 리소스를 부분적으로 변경한다.
  • PUT과 비슷하지만, 부분적으로 수정하는 것이 다르다.
• DELETE는 리소스를 제거한다.
• HTTP 메서드의 속성에는 안전, 멱등, 캐시 가능가 있다.
  • 안전: 호출해도 리소스가 변경되지 않는 것
  • 멱등: 메서드를 여러 번 호출해도 결과가 항상 똑같은 것
  • 캐시 가능: 응답 결과 리소스를 캐시해서 사용해도 되는가