REST API란?

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

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

REST API를 디자인하는 방법

REST API를 작성할 때는 몇 가지 지켜야할 규칙들이 있다. 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

리차드슨의 REST 성숙도 모델을 구조화하면 다음과 같다.

REST 성숙도 모델은 총 4단계(0~3단계)로 나누어진다.

모든 단계를 충족해야 REST API라고 부를 수 있다고 주장하였지만, 실제로 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있다. 이런 경우를 HTTP API 라고도 부른다.

REST 성숙도 모델

REST 성숙도 모델 - 0단계

REST 성숙도 모델에 따르면, 0단계에서는 단순히 HTTP 프로토콜 을 사용하기만 해도 된다. 물론 이 경우에는 해당 API를 REST API라고도 할 수는 없으며, REST API를 작성하기 위한 기본 단계다.

예시) 허준이라는 이름의 주치의의 예약 가능한 시간을 확인하고, 어떤 특정 시간에 예약하는 상황

위 예시에서는 HTTP 프로토콜을 사용하는 것을 확인핳 수 있다. 이렇듯 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.

REST 성숙도 모델 - 1단계

REST 성숙도 모델에 따르면, 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.

엔드포인트(Endpoint): 네트워크에 연결하고 네트워크를 통해 통신하는 모든 디바이스

REST API의 정의처럼 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 요청하고 받는 자원에 대한 정보릃 응답으로 전달해야 한다는 것이 1단계의 핵심이다.

0단계에서는 요청에서의 엔드포인트로 모두 /appointment 를 사용하였다. 하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용한다.

위에 예시에서 예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원(리소스)은 허준이라는 의사의 예약 가능한 시간대다.

• 요청 시 /doctros/허준 이라는 엔드포인트를 사용한 것을 확인할 수 있다.
• 또 특정 시간에 예약하게 되면, 실제 slots라는 리소스의 123이라는 id를 가진 리소스가 변경되어 하단의 특정 시간에 예약이라는 요청에서는 /slots/123 으로 실제 변경되는 리소스를 엔드포인트로 사용하였다.

TIP

1. 예시와 같이 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요하다.

2. 엔드포인트 작성 시에는 동사, HTTP 메소드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.

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

   예) 김코딩 환자가 허준 의사에게 9시에 예약을 진행하였으나 해당 시간이 마감되어 예약이 불가능하다고 가정할 때 아래와 같이 리소스 사용에 대한 실패 여부를 포함한 응답을 받아야 한다.

REST 성숙도 모델 - 2단계

REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.

앞서 0단계와 1단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메서드를 사용하고 있다. 그러나 REST 성숙도 모델 2단계에 따르면, 이는 CRUD에 따른 적합한 메서드를 사용하는 것이 아니다.

• 조회(READ): 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회하는 행위
• 생성(CREATE): 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성한다는 것

GET

그렇게 때문에 조회하기 위해서는 GET 메서드를 사용하여 요청을 보내고, 이때 GET 메서드는 body 를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다.

POST

예약을 생성하기 위해서는 POST 메서드를 사용하여 요청을 보내야 하며, POST 요청에 대한 응답이 어떻게 반환되는지 중요하다.

• 이 경우 응답은 새롭게 생성된 리소스를 보내준다.
• 응답 코드는 201 Created 로 명확하게 작성해야 한다.

관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있다.

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

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

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다.

물론 로이 필딩은 3단계까지 만족하지 못한 API는 REST API가 아닌 HTTP API라고 불러야 한다고 주장하지만, 개발자로서 보시게 될 모범적인 API 디자인조차도 REST 성숙도 모델의 3단계까지 적용한 경우는 드물다.

따라서 3단계까지 무조건적으로 모두 적용해야 하는 것은 아니다.

REST 성숙도 모델 - 3단계

마지막 단계인 3단계에서는 HATEOAS(Hypermedia As The Engine Of Application State) 라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.

이때 응답에 들어가게되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

예를 들어 위와 같이 허준이라는 의사 예약 가능 시간을 확인한 후에는

• 그 시간대에 예약을 할 수 있는 링크를 삽입하거나
• 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다.

이렇게 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트다.

만약 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있다.

Reference

CODESTATES (SEB_FE_43)