HTTP - (4) HTTP API

김영한님의 모든 개발자를 위한 HTTP 웹 기본 지식을 공부하고 정리하는 포스트입니다.

---

[HTTP API]

요구사항

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

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

API URI 설계

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

이것이 과연 좋은 URI 설계일까?
무엇을 기준으로 URI를 설계 해야할까?
가장 중요한 것은 리소스 식별!!!

1. 리소스

• 리소스의 의미는 뭘까?
  • 회원을 등록하고 수정하고 조회하는게 리소스가 아니다
  • 예) 미네랄을 캐라 -> 미네랄이 리소스
  • 위의 같은 경우 회원이라는 개념 자체가 바로 리소스다.
• 리소스를 어떻게 식별하는게 좋을까?
  • 회원을 등록하고 수정하고 조회하는 것은 모두 배제
  • 회원이라는 리소스만 식별하면 된다 -> 회원 리소스를 URI에 매핑

2. API URI 설계

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

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

리소스와 행위를 분리

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

• URI는 리소스만 식별
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사 (미네랄을 캐라)
• 행위는 어떻게 구분할까?

3. HTTP method

클라이언트가 서버에 무언가 요청을 할 때 기대하는 행동

주요 메서드

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

기타 메서드

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

1) GET

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

2) POST

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

POST는 요청 데이터를 어떻게 처리한다는 뜻일까?

• 스펙 : POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청한다.
• 예를 들어 POST는 다음과 같은 기능에 사용된다.
  • HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공(HTML FORM으로 회원가입, 주문 등)
  • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시(게시판 글쓰기, 댓글 달기 등)
  • 서버가 아직 식별하지 않은 새 리소스 생성(신규 주문 생성 등)
  • 기존 자원에 데이터 추가(한 문서 끝에 내용 추가하기 등)
• 정리 : 이 리소스 URI에 POST 요청이 오면 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 -> 정해진 것이 없음

정리

(1) 새 리소스 생성(등록)

• 서버가 아직 식별하지 않은 새 리소스 생성

(2) 요청 데이터 처리

• 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
• 예) 주문에서 결제 완료 -> 배달 시작 -> 배달 완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
• POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
• 예) POST /orders/{orderId}/start-delivery (컨트롤 URI, 리소스만으로 URI를 설계하지 못하는 경우도 있다)

(3) 다른 메서드로 처리하기 애매한 경우

• 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
• 애매하면 POST

3) PUT

• 리소스를 대체(있으면 대체하고 없으면 생성, 쉽게 말해 덮어버림)
• 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점

• 리소스를 완전히 대체하여 수정하고 싶은 필드만 수정하면 기존 리소스는 다 사라짐
  (모든 필드에 대하여 수정을 해야 함, PUT은 수정에 적합하지 않음)
  

4) PATCH

• 리소스 부분 변경
  
• PATCH가 지원이 안되는 서버의 경우 POST를 사용하면 됨

5) DELETE

• 리소스 제거
• 클라이언트가 리소스 위치를 지정하여 제거

4. HTTP 메서드의 속성

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

1) 안전

• 호출해도 리소스를 변경하지 않는다.
• 메서드를 계속 호출해서 로그 같은게 쌓여서 장애가 발생하면?
  -> 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.

2) 멱등

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

3) 캐시 가능

웹 브라우저에 중복되는 리소스를 요청하지 않기 위해 캐시에 저장한다.

• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• GET, HEAD, POST, PATCH 캐시 가능
• 실제로는 GET, HEAD 정도만 캐시로 사용 -> 똑같은 리소스와 키가 맞아야 하는데 둘 이외는 복잡함
  • POST, PATCH는 본문 내용까지 캐시 키로 고려해야 함, 구현이 쉽지 않음