REST API

REST(Representational State Transfer) API

로이 필딩(Roy Fielding)의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개 되었다.

웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 뜻한다.

 

 

REST API 디자인

로이 필딩이 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

 

Richardson의 성숙도 모델(RMM)

REST 성숙모 모델은 총 4단계(0~3)로 나누어진다. 실제로는 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API라고 부른다.

 

 

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.

HTTP 프로토콜을 사용하였다.

 

REST 성숙도 모델 - 1단계

1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다. 

REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현하여야 한다. 따라서 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며, 요청하고 받는 자원에 대한 정보를 응답으로 전달해야한다는 것이 1단계의 핵심이다.

0단계 예시에서는 /appointment를 사용하였지만, 1단계에서는 /doctors/허준 , /slots/123이라는 엔드포인트를 사용하였다.

어떤 리소스를 변화시키는지, 혹은 어떤 응답이 제공되는지에 다라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요하다. 엔드포인트 작성 시에는 동사, HTTP메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.

리소스 사용 실패를 반환하는 예시.

더불에 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환하여야 한다.

 

 

REST 성숙도 모델 - 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 준다. 앞의 예시들에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST메서드를 사용하였다. 하지만 이는 REST 성숙도 모델 - 2단계를 만족시키지 못하고 있는 것이다.

REST 성숙도 모델 - 2단계의 좋은 예시.

예시처럼, 예약 가능한 시간을 확인한다는 것은 예약이 가능한 시간을 조회(READ)하는 행위를 의미하고, 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)하는 것과 같다. 그렇기 때문에 조회하기 위해서는 GET 메서드를 사용하여 요청을 보내고, 이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다. 

 

예약을 생성하기 위해서는 POST 메서드를 사용하여 요청을 보내야 하며, 응답 코드는 201 Created로 명확하게 작성하여야 한다. 관련 리소스 클라이언트가 Locations 헤더에 작성된 URI를 통해 확인할 수 있도록 하며 완벽하게 REST 성숙도 모델 - 2단계를 충족한 것이라 볼 수 있다.

 

HTTP 메서드를 사용할 때에는 몇 가지 규칙에 유의해야 한다.

• GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용하여야 한다.
• POST 메서드는 요청마다 새로운 리소스를 생성하고, PUT 메서드는 요청마다 같은 리소스를 반환한다. 
• PUT과 PATCH도 잘 구분하여 사용하여야 한다. PUT은 교체, PATCH는 수정의 용도로 사용한다.

 

 

REST 성숙도 모델 - 3단계

HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.

3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여야 한다.

링크를 삽입해준 예시.