- 김영한님의 모든 개발자를 위한 HTTP 웹 기본 지식을 수강하면서 정리한 내용입니다.
📌 HTTP API를 만들어보자
요구사항 > 회원 정보 관리 API를 만들어라.
• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제
API URI 설계
• 회원 목록 조회 /read-member-list
• 회원 조회 /read-member-by-id
• 회원 등록 /create-member
• 회원 수정 /update-member
• 회원 삭제 /delete-member
이것은 좋은 API URI 설계인가 ❓
- 아니다. 현업에서는 위와 같이 요구사항 기반으로 잘못된 설계를 한다.
그럼 좋은 API URI 설계방법은 ❓
리소스를 식별하는 것이다.
API URI 설계 분리
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사
- 행위(메서드)는 어떻게 구분? HTTP 메서드
요구사항 > 회원 정보 관리 API를 만들어라.
• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제
API URI 설계
• 회원 목록 조회 /members
• 회원 조회 /members/{id}
• 회원 등록 /members/{id}
• 회원 수정 /members/{id}
• 회원 삭제 /members/{id}▫ 계층 구조상 상위를 컬렉션으로 보고 복수 단어 사용 권장(member ➡️ members)
📌 HTTP 메서드
HTTP 메서드 종류
주요 메서드
- GET : 리소스 조회
- POST : 요청 데이터 처리, 주로 등록에 사용
- PUT : 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH : 리소스 부분 변경
- DELETE : 리소스 삭제
기타 메서드
- HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
💙 GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query (쿼리 파라미터, 쿼리 스트링)를 통해서 전달
- 메시지 body를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
💙 POST
- 요청 데이터 처리
- 메시지 body를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 body를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다. - 주로 전달된 데이터로 신규 리소스 등록, 변경된 프로세스 처리에 사용
리소스를 /members POST로 전달하면 서버 입장에서는 '그 데이터를 내부적으로 어떻게 쓸거야'라고 미리 서로 약속해놓는다.
클라이언트는 필요한 데이터를 전달한다. 그러면 서버에서는 신규로 등록한다고 /members에서 100 신규 리소스 식별자를 생성한다. 신규로 자원이 생산 된 경로를 응답메시지로 보낸다.
💬 201 Created
요청이 성공적으로 처리되었으며, 자원이 생성되었음을 나타내는 성공 상태 응답 코드.
해당 HTTP 요청에 대해 회신되기 이전에 정상적으로 생성된 자원은 회신 메시지의 본문(body)에 동봉되고,
구체적으로는 요청 메시지의 URL이나, Location (en-US) 헤더의 내용에 위치하게 된다.
이 상태코드(status code)는 일반적으로 POST 요청(request)에 대한 응답결과(result)로써 사용한다.POST 예시, 요청 데이터를 어떻게 처리한다는 뜻일까?
- 스펙 : POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청합니다.
(구글 번역)
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
- 예) 게시판 글쓰기, 댓글 달기
- 서버가 아직 식별하지 않은 새 리소스 생성
- 예) 신규 주문 생성
- 기존 자원에 데이터 추가
- 예) 한 문서 끝에 내용 추가하기
👉 이 리소스 URI에 POST 요청이 오면 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 → 정해진 것이 없음
POST 정리
새 리소스 생성 (등록)- 서버가 아직 식별하지 않은 새 리소스 생성
요청 데이터 처리- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
- 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 실무에서 어쩔 수 없이 리소스만으로 설계가 안 될때가 있음
다른 메서드로 처리하기 애매한 경우- 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST
👉 POST는 모든 것을 할 수 있음 / 조회할때는 GET을 쓰는게 유리함 (애매한 경우에는 POST 사용)
💙 PUT
- 리소스를 완전히 대체
- 리소스가 있으면 대체
- 리소스가 없으면 생성 - 클라이언트가 리소스를 식별
- 클라이언트가 구체적인 리소스 위치를 알고 URI 지정
- POST와 차이점
💙 PATCH
- 리소스 부분 변경
👉 PATCH가 지원이 안 되는 서버도 있음 → POST 사용
💙 DELETE
- 리소스 제거
📌 HTTP 메서드의 속성
안전(Safe Methods)
- 호출해도 리소스가 변경하지 않는다.
- GET은 단순히 조회만 하기 때문에 안전하다. 한번 호출해도 여러번 호출해도 변경이 일어나지 않아서 안전하다.
- POST, PUT, PATCH, DELETE는 안전하지 않다.
- 그래도 계속 호출해서 서버에서 로그가 계속 쌓여서 장애가 발생하면? 안전은 그런 부분까지 고려하지 않는다. 안전은 해당 리소스가 변경이 되는지만 고려한다.
멱등(Idempotent Methods)
- f(f(x)) = f(x)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
- 멱등 메서드
- GET : 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
-POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
💬 HTTP 스펙은 POST가 멱등을 보장하지 않지만, 실제 개발하면서 POST에도 멱등성을 보장하게 개발하는 것은 가능하다.
• 사용자1: GET -> username:A, age:20
• 사용자2: PUT -> username:A, age:30
• 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회역등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
클라이언트가 동일한 요청을 똑같은 클라이언트가 동일한 요청했을 때만 멱등한다. 즉 멱등은 동시성 문제까지 고려하지 않는다.
멱등 활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거
캐시가능(Cacheable Methods)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
💬 캐시를 이해하는 중요한 키는 데이터의 변경 관점이다.
캐시라는 것은 원본 데이터가 변경되지 않고 유지되어야 한다.
그런데 POST, PUT, DELETE, PATCH로 데이터를 변경하게 되면 원본 데이터가 변경되기 때문에
캐시를 유지하기가 어렵다.
그래서 데이터 변경 관점으로 이해면 된다.
GET은 단순 조회이기 때문에 데이터를 변경하지 않는다.
HTTP에서는 이렇게 선언해두었지만, 실제로는 데이터를 변경할 가능성이 있는
POST, PUT, DELETE, PATCH는 대부분의 구현에서 캐시를 유지하지 않는다.