HTTP 웹 기본 지식 #4

#4

• API URI 설계
• HTTP 메서드
• HTTP 메서드의 속성

4.1 API URI 설계

URI 설계의 가장 중요한 것은 리소스를 식별하는 것
리소스 = 자원
회원등록, 회원수정, 회원조회는 리소스가 아님 리소스는 회원 그 자체
회원이라는 리소스만 식별하면 됨 -> 회원 리소스를 URI에 매핑 (행위는 배제)

• 리소스 식별, URI 계층 구조 활용
  • 회원 목록 조회 /members
  • 회원 조회 /members/{id}
  • 회원 등록 /members/{id}
  • 회원 수정 /members/{id}
  • 회원 삭제 /members/{id}

참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

행위(메서드)는 어떻게 구분? -> HTTP 메서드

4.2 HTTP 메서드

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

4.2.1 GET

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

4.2.2 POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
• 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• 리소스 URI에 POST 요청이 오면 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함

정리

• 새 리소스 생성
  • 서버가 아직 식별하지 않은 새 리소스 생성
• 요청 데이터 처리
  • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
  • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
• 다른 메서드로 처리하기 애매한 경우
  • JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
    -> 조회이지만 POST를 써야함
  • 애매하면 POST

4.2.3 PUT

• 리소스를 대체
  • 리소스가 있으면 완전히 대체, 기존 리소스를 덮어버림 (일부분 변경이 안됨)
  • 리소스가 없으면 생성
• 클라이언트가 리소스를 식별
  PUT /members/100 HTTP/1.1
  • 클라이언트가 리소스 위치를 알고 URI 지정 -> POST와의 차이점

4.2.4 PATCH

• 리소스 부분 변경 -> PUT과 다르게 일부분만 변경 가능
• PATCH 지원이 안되는 서버일땐 POST로 대체하면 됨

4.2.5 DELETE

• 리소스 제거

4.3 HTTP 메서드의 속성

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

4.3.1 안전

• 호출해도 리소스가 변경되지 않는다. -> GET , HEAD
  안전은 해당 리소스만 고려함
• POST, PUT, DELETE는 호출하면 리소스가 변경되기 때문에 안전하지 않음

4.3.2 멱등

사전적 의미 : 연산을 여러 번 적용하더라도 결괏값이 달라지지 않는 일

• 한 번 호출하든 두 번 호출하든 결과가 같음
• 멱등 O
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회됨
  • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 같은 결과
    ex) 같은 파일을 계속 올림
  • DELETE: 같은 요청을 여러번 해도 삭제된 결과는 같음
• 멱등 X
  • POST: 두 번 호출하면 같은 행위가 중복해서 발생할 수 있다.
    ex) 배송을 두번 누른다.

활용

• 자동 복구 메커니즘
• 서버가 비정상 응답을 주었을 때, 클라이언트가 같은 요청을 해도 괜찮은 경우
  • ex) DELETE를 시도했는데 처리 됐는지 잘 모름 -> 자동으로 DELETE 재시도
    (멱등하기 때문에 똑같은 요청을 시도해도 결과는 같음)

멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다

4.3.3 캐시가능

• 응답 결과 리소스를 캐시로 사용할 수 있는가
  • ex) 웹 브라우저에 한 번 요청한 이미지를 로컬에 저장할 수 있는가
• GET, HEAD, POST, PATCH 캐시가능
• 실제로는 GET, HEAD 정도만 캐시로 사용

<출처>

모든 개발자를 위한 HTTP 웹 기본 지식 - 김영한