[HTTP/Network] REST API

REST API

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

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

 

REST API 디자인

 

레오나르드 리처드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 위와 같이 만들었다.

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

 

REST API 성숙도 모델 0단계 

단순히 HTTP 프로토콜을 사용하기만 해도 된다. 물론 이 경우를 REST API 라고는 할 수 없으나, REST API를 작성하기 위한 기본 단계라고 할 수 있다. 

 

REST API 성숙도 모델 1단계 

1단계에서는 개별 리소스와의 통신을 준수해야 한다. 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야 하며, 요청하고 받는 자원에 대한 정보를 응담으로 전달해야 한다는 것이 1단계의 핵심이다.

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

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

 

REST API 성숙도 모델 2단계 

2단계에서는 CRUD(Create, Read, Update, Delete)에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.

주로, Create : POST, Read : GET, Update: PUT or PATCH, Delete: DELETE 로 HTTP 메서드를 사용한다.

- GET 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.

- POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등이라 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드 POST를 구분해 사용해야 한다.

- PUT 메서드와 PATCH 메서드도 구분해야 한다. PUT은 교체, PATCH는 수정의 용도 이다.

 

REST API 성숙도 모델 3단계 

3단계는 HATEOAS(Hypermedia As The Engine Of Application State)로 표현되는 하이퍼미디어 컨트로를 적용해야 한다.

요청은 2단계와 동일하지만, 응답에 리소스의 URI를 포함한 링크 요소를 삽입해 작성해야 한다. 이때 링크 요소는 응답을 받은 후 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

 

 

 

Open API

글자 그대로 열려있는 API. 그러나 무제한으로 사용할 수는 없다. API마다 정해진 이용 수칙이 있고 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.

 

API Key

API를 이용하기 위해선 API Key가 필요하다. 이 키는 서버의 문을 여는 열쇠다. 서버를 운용하는 데에 비용이 발생하기 때문에 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무가 서버에게는 없다. 

API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 해당 키를 같이 전달해야 원하는 응답을 해준다.