[HTTP] HTTP API

해당 글은 김영한 모든 개발자를 위한 HTTP 웹 기본 지식을 보고 요약, 정리하며 개인적인 견해가 들어간 글입니다.

HTTP API

HTTP API를 만들어보자.

요구사항

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

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

API URI 설계

URI(Uniform Resource Identifier)

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

개발자라면, URL 설계가 최선인지 항상 고민해야함

API URL 고민

• 리소스란 무엇일까?
  • 회원을 등록하고 수정하는 과정 그 자체가 리소스가 아니다.
  • 회원만 리소스가 된다.
  • 즉, 회원이라는 개념 자체가 리소스다.
• 리소스를 어떻게 식별해야 할까?
  • 회원 등록, 수정, 조회하는것을 모두 배제해야한다.
  • 회원이라는 리소스만 식별하면 된다.
  • 즉, 회원 리소스를 URI에 매핑하면 된다.

API URI 설계

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

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

하지만, 위와 같이 설계할 경우 조회, 등록, 수정, 삭제와 같은 기능을 구분할 수 없다는 문제가 발생한다.

때문에 이를 해결하기 위해 메서드를 사용한다.

여기서 우리가 생각해야하는건 리소스와 기능(메서드)을 분리한다는 것이다.

• 리소스: 회원
• 메서드: 조회, 등록, 삭제, 변경

리소스는 명사, 메서드는 동사라고 생각할 수 있다.

HTTP 메서드 - GET, POST

주요 메서드

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

기타 메서드

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

GET

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

리소스 조회1 - 메시지 전달

리소스 조회2 - 서버도착

리소스 조회3 - 응답 데이터

POST

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

리소스 등록1 - 메시지 전달

리소스 등록2 - 신규 리소스 생성

리소스 등록3 - 응답 데이터

요청 데이터를 어떻게 처리한다는 뜻인지 예시

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

정리

1. 새 리소스 생성(등록)
   • 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
   • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
   • 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
   • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
   • 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
   • 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
   • 애매하면 POST

즉, 조회만 할 경우에는 GET 메서드를 주로 사용하지만, 변경이나 수정과 같은 데이터가 변형되는 경우 POST를 주로 사용한다고 생각하면 된다.

HTTP 메서드 - PUT, PATCH, DELETE

PUT

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 쉽게 이야기해서 덮어버림
• 중요! 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점
    • POST: POST /members HTTP/1.1
    • PUT: PUT /members/100 HTTP/1.1
    • 즉, POST는 정확한 리소스가 위치를 식별할 수 없지만 PUT은 100이라는 위치를 식별한다는 차이를 가진다.

리소스가 있는 경우1

리소스가 있는 경우2

리소스가 없는 경우1

리소스가 없는 경우2

리소스를 완전히 대체한다1

만약 나이를 20에서 50으로 변경하려고 할 경우다.

리소스를 완전히 대체한다2

수정하려고 PUT을 사용하면 기존 username필드가 삭제되고 새로운 필드로 대체된다.

즉, “age": 50을 제외하고 기존에 있던 “username”: “young”은 삭제된다.

PATCH

• 리소스 부분 변경
  • 앞에 PUT을 사용시 리소스 변경이 어렵다는것을 알았다.
  • 때문에 리소스를 변경할때는 PATCH를 사용하면 된다.

리소스 부분 변경1

리소스 부분 변경2

DELETE

• 리소스 제거
  • 리소스를 변경하는게 아니라 제거할 경우에는 DELETE를 사용하면 된다.

리소스 제거1

리소스 제거2

참고사항

PATCH가 지원이 안되는 서버도 있다고 한다.

이 경우에는 POST를 사용하면 된다.

HTTP 메서드의 속성

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

자료 출처: 위키피디아

안전 (Safe)

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

멱등 (Idempotent)

• f(f(x)) = f(x)
• 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
    • 조회는 데이터를 수정하지 않기 때문에 결과가 바뀌지 않음
  • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
    • 서버에 데이터를 업데이트 한다는 개념으로 업데이트를 여러번 하더라도 최종 버전은 동일하다.
  • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
    • 한번 데이터를 삭제하면 더이상 서버에 데이터가 존재하지 않기 때문에 여러번 삭제해도 결과는 동일하게 나온다.
  • POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
    • POST를 사용해서 새 게시물을 생성하는 경우, 여러번 호출할 경우 여러개의 게시물이 생성되기 때문에 상태가 변화된다.
• 활용
  • 자동 복구 메커니즘
  • DELETE를 호출했는데 서버에 응답이 없어 다시 DELETE를 호출하더라도 멱등상태이기 때문에 상관이 없다.
• Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?
  • 사용자1: GET -> username:A, age:20
  • 사용자2: PUT -> username:A, age:30
  • 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회
• A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.

캐시가능 (Cacheable)

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