ABOUT.Series (4) HTTP 메소드

 

< 목록 >

1. API URI 설계
2. HTTP 메소드
3. HTTP 메소드 속성

 

 

1. API URI 설계 

상품 정보 관리 API를 설계하는 경우를 생각해보자.

이 때 가장 중요한 것은 리소스 식별이다.

 

API URI를 설계할 때 우리는 다음과 같은 고민을 해볼 수 있다.

• 리소스란??
  • 상품을 등록하고 수정하고 조회하는게 리소스가 아니다.
  • 상품이라는 개념 자체가 바로 리소스이다.
• 리소스를 어떻게 식별하는게 좋을까??
  • 상품을 등록하고 수정하고 조회하는 것을 모두 배제
  • 상품이라는 리소스만 식별하면 된다.  ->  상품 리소스를 URI에 매핑

이러한 고민을 바탕으로 리소스를 식별한 다음 URI 계층 구조를 활용해 다음과 같이 API를 설계해 보았다.

• 상품 목록 조회  /items
• 상품 조회  /items/{id}
• 상품 등록  /items/{id}
• 상품 수정  /items/{id}
• 상품 삭제  /items/{id}
• 참고 : 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 (item -> items)

리소스에 매칭해서 URI를 설계하게 되면 위와 같이 상품 조회, 등록, 수정, 삭제를 구분하는 데에 있어서 문제가 발생한다. 그렇기 때문에 우리는 리소스와 행위를 분리해야만 한다. 다시 한번 언급하지만 가장 중요한 것은 리소스 자체를 식별하는 것이다.

• URI는 리소스만 식별
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스  :  상품
  • 행위  :  조회, 등록, 수정, 삭제
• 리소스는 명사형, 행위는 동사형

URI는 리소스의 행위가 아닌 리소스 자체를 식별하는데 사용되어야 하고 행위는 HTTP 메소드를 사용해 구분할 수 있다. 하지만, 실무에서 리소스만을 가지고 모든 URI를 설계한다는 것은 불가능하다. 기본적으로 리소스만을 가지고 최대한 URI를 설계하되 어쩔 수 없는 부분들은 컨트롤 URI 라는 것으로 설계를 하게 된다. 

 

 

 

2. HTTP 메소드 

HTTP 메소드는 클라이언트가 서버에 요청을 할 때 어떤 것을 기대하는 행위이다.

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

 

👉  GET 

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해 전달

 

👉  POST 

• 요청 데이터 처리
• message body를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리 (message body를 통해 들어온 데이터를 처리하는 모든 기능을 수행)
• 전달된 데이터로 신규 리소스 등록 / 프로세스 처리에 주로 사용
• POST 메소드는 사실상 모든 것을 할 수 있음  ->  다른 메소드로 처리하기 애매한 경우 POST 사용

 

👉  PUT 

• 리소스를 대체
  • 리소스가 있으면 대체  (완전히 대체)
  • 리소스가 없으면 생성
  • 쉽게 말해, 덮어쓰기
• PUT 메소드에서는 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI를 지정
  • POST 와의 차이점

 

👉  PATCH 

• 리소스 부분 변경
• PUT 은 리소스를 완전히 대체한다는 점에서 PATCH 와 구분됨
• PATCH 가 지원되지 않는 서버의 경우 POST 사용

 

👉  DELETE 

• 리소스 제거

 

다음은 위키피디아에서 가져온 HTTP 메소드별 특징이 정리된 표이다. 참고하길 바란다.

출처 : 위키피디아

 

 

 

3. HTTP 메소드 속성 

• 안전 (Safe Methods)
  • 호출해도 리소스를 변경하지 않는 것을 안전하다고 한다.
• 멱등 (Idempotent Methods)
  • f(f(x)) = f(x)
  • 몇 번을 호출하든 똑같은 결과값을 갖는다.
  • 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려 X (동일한 사용자가 똑같은 요청을 여러번 한 것에 대해서만 고려)
  • 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거
• 캐시 가능 (Cacheable Methods)
  • 응답 결과 리소스를 캐시해서 사용해도 되는가?
  • GET, HEAD, POST, PATCH 캐시 가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용