[네트워크] REST API(Representational State Transfer)의 이해

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

 API를 작성할 때는 잘 알아볼 수 있도록 작성하는 것이 중요하다. 그렇다면 API를 작성하는 방법은 어떻게 될까?

 

리차드슨의 REST 성숙도 모델을 통해서 단계별로 알아보자

 

REST 성숙도 0단계

 

0단계는 REST API를 작성하기 위한 가장 기본단계로 HTTP 프로토콜을 사용한다. 

 

REST 성숙도 1단계

 

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

 다시 말하자면 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야하며 요청하고 받은 자원에 대한 정보를 응답으로 전달해야한다. 또한 엔드포인트는 명사형으로 작성하는 것이 바람직하다.

 

더불어 리소스 사용에 대해 성공과 실패 여부를 반환해야 한다. 

 

REST 성숙도 2단계

 

REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용해야 한다. 

 

메서드 사용의 규칙

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

 

REST 성숙도 3단계

 

하이퍼컨트롤(HATEOAS / Hypertext As The Engine Of Application State)을 적용한다. 

 

3단계의 요청은 2단계와 동일하다. 

하지만, 응답은 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다. 

 

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

 

 

Open API

 

open API란 무엇일까?

 

누구에게나 열려있는 API를 뜻한다.

대게 정부 등 공공기관이나 공익을 목적으로 제공되는 API가 있다. (데이터를 JSON형태로 응답한다.)