HTTP API 만들기 (HTTP Method의 역할)

해당 시리즈는 김영한님 강의를 보고 정리한 시리즈입니다.

목차

1. HTTP API 만들기
   1. 요구사항
   2. API URI 고민
   3. API URI 설계
2. HTTP 메서드 종류
   1. GET : 리소스 조회
   2. POST : 요청 데이터 처리
   3. PUT : 리소스를 대체
   4. PATCH : 리소스 부분 변경
   5. DELETE : 리소스 삭제
   6. PATCH를 지원 안하는 서버는 POST를 사용한다
   7. 기타 메서드
3. HTTP 메서드의 속성
   1. 안전(Safe)
   2. 멱등(Idempotent)
   3. 캐시가능 (Cacheable)

1. HTTP API 만들기

1. 요구사항

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

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

2. API URI(Uniform Resource Identifier) 고민

• 리소스의 의미는?
  • 회원이라는 개념 자체가 바로 리소스다
• 리소스를 어떻게 식별하는게 좋을까?
  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별! → 회원 리소스를 URI에 매핑

3. API URI(Uniform Resource Identifier) 설계

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

4. 리소스와 행위를 분리

• URI는 리소스만 식별한다.
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
• 리소스 : 회원
• 행위 : 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사 (회원 정보를 가져와라)
• 행위는 HTTP Method로 구분!!

2. HTTP 메서드 종류 (Resources Representation)

1. GET : 리소스 조회

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

2. 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳(서버)이 많아서 권장하지 않음.

   → 웬만하면 GET에는 Requestbody를 사용하여 서버에 요청하지 말 것!

3. Request, Response

   1. Request (쿼리스트링과 HTTP 버전, HOST를 보낸다)

2. 서버에선 해당 리소스에 관한 Json(Xml등)을 생성하여 Response한다.

2. POST : 요청 데이터 처리, 주로 등록에 사용

1. 메시지 바디를 통해 서버로 요청 데이터 전달

2. 서버는 요청 데이터를 처리

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

3. Reqeust, Response

   1. 리소스 생성에 필요한 데이터 request 메시지에 실어서 서버에 요청한다.
      

   2. 서버에서는 해당 요청에 따라서 리소스 식별자를 생성한다.
      

   3. 리소스가 생성된 경로를 포함하여 HTTP 메시지를 생성하여 response 한다.
      

4. 예를 들어 POST는 다음과 같은 기능에 사용된다.

   • HTML FORM에서 입력한 정보로 회원가입, 주문 등에서 사용한다.
   • 메시지 게시 (게시판 글쓰기, 댓글달기)
   • 서버가 아직 식별하지 않은 새 리소스 생성
   • 기존 자원에 데이터 추가
     • 한 문서 끝에 내용 추가하기

5. 정리 : 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함!! → 정해진 것이 없다고 할 수 있음. (사실상 모든 요청 처리 가능)

   1. 새 리로스 생성(등록)
   2. 프로세스의 상태가 변경되는 경우
   3. POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
   4. 다른 메서드로 처리하기 애매한 경우 (조회 데이터를 넘겨야 하는데 GET 메서드를 사용하기 어려운 경우)

3. PUT : 리소스를 대체, 해당 리소스가 없으면 생성

1. 리소스를 대체

   1. 리소스가 있으면 대체
   2. 리소스가 없으면 생성
   3. 쉽게 얘기하면 리소스를 덮어버린다는 것이다!!

2. 클라이언트가 리소스를 식별한다. (중요)

   1. 클라이언트가 리소스 위치를 알고 URI를 지정한다.
   2. POST와 큰 차이점 → POST는 리소스 파리미터가 없다.

3. Request , Response

   1. 리소스가 있는 경우

      • Request
        
      • Response
        
        원래 위의 리소스가 있었다면,
        
        해당 리소스로 아예 대체해버린다.

   2. 리소스가 없는 경우

      • 새로운 리소스를 만들어낸다.

   3. 주의해야 할 점은, 한가지만 변경할 수 없다.

      • 만약 일부만 수정한다면 일부 데이터 외에는 아예 빈값이 들어가버린다.
      • 일부만 수정하고 싶다면 PATCH를 사용한다.

4. PATCH : 리소스 부분 변경

• Request, Response
  • Request
    
  • Response
    
    • 부분 변경 된다.
      

5. DELETE : 리소스 삭제

• Request, Response
  • Request
    
  • Response
    

6. PATCH를 지원 안하는 서버는 POST를 사용한다.

7. 기타 메서드

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

3. HTTP 메서드의 속성

• 안전 (Safe Methods)
• 멱등(Idempotent Mothods)
• 캐시가능(Cacheable Methods)

1. 안전(Safe)

• 호출해도 리소스를 변경하지 않는다.
• 해당 리소스가 변하는가.에 대해서만 생각한다.!

2. 멱등(Idempotent)

• 한 번 호출하든, 두 번 호출하든 100번 호출하든 결과가 똑같은 것을 말함.
• 멱등 메서드
  • GET : 한번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
  • PUT : 결과를 대체한다. 따라서 같은 요청을 여러 번 하더라도 최종 결과는 같다.
  • DELETE : 결과를 삭제한다. 같은 요청을 여러 번 해도 삭제된 결과는 똑같다.
  • POST : 멱등이 아니다! 두 번 호출하면 리소스가 중복해서 발생할 수 있다.
• 활용
  • 자동 복구 매커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? << 판단 근거 (항상 같은 결과를 반환하기 때문에 맞는 말이다)
• Q : 재요청 중간에 다른 곳에서 리소스를 변경해버리면??
  • 사용자 1 : GET → username : A, age : 20
  • 사용자 2 : PUT → username : A, age : 30
  • 사용자 1 : GET → username : A, age : 30 → 사용자 2의 영향으로 바뀐 데이터를 조회.
• A : 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다.

3. 캐시가능 (Cacheable)

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

참조

• 김영한님 인프런 강의