API URI 설계

좋은 URI 설계

가장 중요한 것은 리소스 식별

• 리소스는 ‘행위’가 아니라, 개념 자체이다.
  • 회원을 등록하라 → ‘회원’이 리소스
• URI는 리소스만 식별한다.
  • 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • create, update, delete는 행위, member는 리소스
• 행위는 HTTP 메서드를 통해 표현

URI 계층 구조를 활용한 예제

💡 계층 구조 상 상위를 컬렉션으로 보고 복수 단어 사용 권장

• 회원 목록 조회 /members
• 회원 조회 /members/{id}
• 회원 등록 /members/{id}
• 회원 수정 /members/{id}
• 회원 삭제 /members/{id}

HTTP 메서드

HTTP 메서드 종류

• GET
  • 리소스 조회
• POST
  • 요청 데이터 처리
• PUT
  • 리소스를 대체
  • 해당 리소스가 없으면 생성
• PATCH
  • 리소스 부분 변경
• DELETE
  • 리소스 삭제
• HEAD
  • GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS
  • 대상 리소스에 대한 통신 가능 옵션(메서드)를 설명
  • 주로 CORS에서 사용
• CONNECT
  • 대상 리소스로 식별되는 서버에 대한 터널을 설정
• TRACE
  • 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

GET

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

POST

POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다.

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

POST를 사용하는 경우

• 새 리소스 생성 (등록)
  • 서버가 아직 식별하지 않은 새 리소스 생성
• 요청 데이터 처리
  • 단순히 데이터를 생성하거나 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
  • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
  • 컨트롤 URI를 사용하기도 한다.
  • 예) 주문 시 ‘결제완료 → 배달시작 → 배달완료’ 처럼 값 변경을 넘어 프로세스의 상태가 변경되는 경우
• 다른 메서드로 처리하기 애매한 경우
  • JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
• 일반적으로 다음과 같은 기능에 사용된다.
  • HTML FROM에 입력한 정보로 회원 가입, 주문 등
  • 게시판 글쓰기, 댓글 달기
  • 서버가 아직 식별하지 않은 새 리소스 생성 (신규 주문 생성)
  • 기존 자원에 데이터 추가 (문서의 끝에 문장 추가)

PUT

• 리소스를 완전히 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
• 클라이언트가 리소스를 식별한다.
  • POST와의 차이점!
  • ex) 회원 번호가 100번인 회원의 정보를 변경: /members/100

주의점

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

예를 들어, 서버에 회원(리소스) 정보가 다음과 같이 있다고 하자.

{
	"name" : "Gil-Dong"
	"age" : 17
}

이를 PUT 메서드로 다음과 같이 요청한다면,

PUT /members/100 HTTP/1.1
Content-Type: application/json
{
 "age": 20
}

최종적으로 리소스는 다음과 같아진다.

{
	// 리소스가 대체되었기 때문에 name 필드가 없어졌다!
	"age" : 20
}

PATCH

• 리소스를 부분 변경한다.

PUT과 PATCH의 차이점

PATCH는 리소스의 일부만 변경한다.

예를 들어, 서버에 회원(리소스) 정보가 다음과 같이 있다고 하자.

{
	"name" : "Gil-Dong"
	"age" : 17
}

이를 PATCH 메서드로 다음과 같이 요청한다면,

PATCH /members/100 HTTP/1.1
Content-Type: application/json
{
 "age": 20
}

최종적으로 리소스는 다음과 같아진다.

{
	"name" : "Gil-Dong"
	"age" : 20
}

DELETE

• 리소스를 제거한다.

HTTP 메서드의 속성

다음은 위키백과에서 가져온 메서드 별 속성이다.

Safe Methods

• 호출해도 리소스를 변경하지 않는 것을 말한다.

Idempotent Methods

멱등이라고도 말한다.

• $f(x) = y$ 일 때, $f(y) = f(x)$
• 여러 번 호출해도 결과가 똑같다.
  • 외부 요인으로 중간에 리소스가 변경되는 것은 고려하지 않는다.
  • 예) 회원A를 조회 중, 다른 사용자가 회원A의 정보를 변경했을 경우
• 멱등 메서드
  • GET: 여러 번 조회해도 같은 결과가 조회된다.
  • PUT: 결과를 완전히 대체한다. 즉, 같은 요청을 여러 번 해도 최종 결과는 같다.
  • DELETE: 결과를 삭제한다. 같은 요청을 해도 삭제된 결과는 똑같다.
  • POST: 멱등이 아니다!

PATCH가 멱등이 아닌 이유

💡 Q. 부분을 변경하는 PATCH도 멱등이 될 수 있지 않나?

PATCH는 멱등으로 설계할 수도 있지만, 멱등이 아니게도 설계할 수 있다.

• 멱등일 경우
  • { name: "kim"}
• 멱등이 아닐 경우
  • 한 번 호출할 때마다 나이를 10 더하도록 변경한다.
  • { "operation": "add", "age": 10"}
  • 첫 번째 호출하면 10, 두 번째 호출하면 20이 되므로 멱등이 될 수 없다.

멱등 메서드의 활용

자동으로 복구하는 메커니즘이 필요할 때 사용된다.

즉, 서버가 TIMEOUT 등으로 정상 응답을 주지 못했을 때, 클라이언트가 같은 요청을 다시 해도 되는지 판단의 근거가 된다.

Cacheable Methods

• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• 캐시 가능 메서드
  • GET
  • HEAD
  • POST
  • PATCH
  • 단, POST와 PATCH는 본문 내용까지 캐시 키로 고려해야 하므로 구현이 쉽지 않아 실제로는 잘 사용되지 않는다.

Reference

인프런 강의

모든 개발자를 위한 HTTP 웹 기본 지식 강의 - 인프런

참고 사이트

Patch 메서드가 멱등이 아닌 이유 - 인프런