REST API

REST API 란?

웹 애플리케이션에선 HTTP 메서드를 이용해 서버와 통신합니다.

GET 을 통해 웹 페이지나 데이터를 요청,

POST 로 새로운 글이나 데이터를 전송,

DELETE 로 저장된 글이나 데이터를 삭제할 수 있습니다.

 

이처럼 클라이언트와 서버가 HTTP 통신을 할 때는 어떤 요청을 보내고 받느냐에 따라 메서드 사용이 달라집니다.

 

REST ( Representational State Transfer ) API 는 웹에서 사용되는 데이터나 자원을 HTTP URI 로 표현하고,

HTTP Protocol 을 통해 요청과 응답을 정의하는 방식을 의미합니다.

 

간단한 비유를 들어보겠습니다.

 

어떤 식당의 손님이 있고, 식사 혹은 음료를 주문한다고 가정해보겠습니다.
메뉴판의 상태가 내가 알아볼 수 없는 언어이고, 가독성이 떨어지는 메뉴판이라고 한다면 주문하기 어렵습니다.
이럴 때 만약, 메뉴판이 잘 알아볼 수 있게 누군가 규정을 해놓는다면 누구나 쉽게 메뉴판을 읽고 주문할 수 있습니다.
이러한 역할을 해주는 것이 REST API 입니다.

클라이언트 - 서버 사이에도 데이터와 리소스를 요청하고, 요청에 따른 응답을 전달해주기 위한 메뉴판이 필요합니다.
이 메뉴판을 보고 클라이언트는 식당에서 식사를 주문하듯 서버에 요청하고,
이에 대한 응답을 다시 서버에서 클라이언트로 전송하게 됩니다.

따라서 HTTP 프로토콜 기반으로 요청과 응답에 따라 리소스를 주고받기 위해선 알아보기 쉽게 작성된 메뉴판이 필요합니다.
이 역할을 API 가 수행해야 하므로 서로 잘 알아볼 수 있도록 작성하는 것이 중요합니다.

 

좋은 REST API 디자인 방법

REST 성숙도 모델을 구조화하면 다음과 같습니다.

실제로는 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있으며, 이런 경우 HTTP API 라고 부릅니다.

 

REST 성숙도 모델 0단계

HTTP 프로토콜을 사용하기만 하면 됩니다.

물론 이 경우, REST API 라고 할 수는 없습니다.

 

 

REST 성숙도 모델 1단계

개별 리소스와의 통신을 준수해야 합니다.

모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야 하며, 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것입니다.

앞선 0 단계에서는 모든 요청에서 엔드 포인트로 /appointment 를 사용했습니다.

하지만 1 단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용해야 합니다.

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

그렇기 때문에 요청 시 /doctors/허준이라는 엔드포인트를 사용한 것을 볼 수 있습니다.

그뿐만 아니라, 특정 시간에 예약하게 되면, 실제 slot이라는 리소스의 123이라는 id를 가진 리소스가 변경되기 때문에, 하단의 특정 시간에 예약이라는 요청에서는 /slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용하였습니다.

 

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

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

 

더불어 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 합니다. 예를 들어 만약 김코딩 환자가 허준 의사에게 9시에 예약을 진행하였으나, 해당 시간이 마감되어 예약이 불가능하다고 가정할 때, 아래와 같이 리소스 사용에 대한 실패 여부를 포함한 응답을 받아야 합니다.

 

 

 

REST 성숙도 모델 2단계

REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둡니다. 앞서 0단계와 1단계 예시에서 보았듯, 모든 요청을 CRUD에 상관없이 POST로 하고 있습니다. 그러나 REST 성숙도 모델 2단계에 따르면 이는 CRUD에 따른 적합한 메서드를 사용한 것은 아닙니다.

 

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

 

또한 예약을 생성(CREATE)하기 위해서는 POST 메서드를 사용하여 요청을 보내는 것이 바람직합니다. 그리고 2단계에서는 POST 요청에 대한 응답이 어떻게 반환되는지도 중요합니다.

 

이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created 로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 해야, 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있습니다.

 

 

물론 메서드를 사용할 때도 규칙이 있습니다.

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

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

물론 로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한다면 REST API가 아니기 때문에 HTTP API라고 불러야 한다고 주장하지만, 뒤에 만나게 되는 레퍼런스의 모범적인 API 디자인조차도 REST 성숙도 모델의 3단계까지 적용한 경우는 극히 드뭅니다. 따라서 3단계까지 무조건적으로 모두 적용해야 한다는 것은 아닙니다.

 

 

 

REST 성숙도 모델 3단계

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

 

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

 

 

예를 들어 위와 같이 허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있습니다.

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

 

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