REST API 완벽 이해하기

지난 포스트에서 클라이언트는 작성된 API를 통해 리소스를 요청할 수 있음을 알 수 있었다. 이번 포스트에서는 API의 대표적인 아키텍처인 REST API에 대해 알아볼 것이다. 

 

 

 

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

REST API 를 디자인하는 방법 

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

2단계까지만 적용해도 좋은 API 디자인  = HTTP API 

 

REST 성숙도 모델 - 0단계

단순히 HTTP 프로토콜을 사용 
ex) 

요청	POST / appointment HTTP/1.1
응답	HTTP/1.1 200 OK

부가적인 요소 없이 단순히 HTTP 프로토콜만 사용하고 있는 것을 알 수 있음 . 이것이 REST API의 출발점 

 

REST 성숙도 모델 - 1단계

개별 리소스와의 통신을 준수해야함.  모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심 
( 엔드포인트는 API가 서버에서 리소스에 접근할 수 있도록 가능하게 하는 URL ) 

요청	POST / coffee / americano HTTP / 1.1
응답	HTTP/1.1 200 OK  {   "order" : {      "slot" : { "id" : 1 , "coffee" : "americano", "price" :"4500" },   ....    } }

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

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

 

REST 성숙도 모델 - 2단계

CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둠. 
0, 1 단계는 모든 요청을 POST 메서드를 사용하고 있었음 .그러나 2단계에서는 적절한 메서드를 사용해야 함. 
조회를 하기 위해선 GET 메서드를 생성을 하기 위해선 POST 를 보내야 함. 이때 POST 요청에 대한 응답이 어떻게 반환 되는지가 중요함. 이경우 응답은 새롭게 생성된 리소스를 보내주기 때문에 응답 코드는 201 Created 로 명확하게 작성해야 하며 클라이언트가 Location 헤더에 작성된 URI 를 통해 확인할 수 있도록 해야 함. 

요청	POST /  slots/1 HTTP/1.1
응답	HTTP/1.1 201 Created Location : slots/1/order {     "order" : {         "slot" : { "id" : 1 , "coffee" : "americano", "price" :"4500" },      ...     } }

HTTP 메서드 사용 규칙 

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

 

REST 성숙도 모델 - 2단계

HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용함.
3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야함
이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있음

요청	GET/ coffee/americano/slots?explain="sobitter" HTTP/1.1
응답	HTTP/1.1 200 OK {    "slots":{          "order" : {                 "href" : "http://localhost:8080/slots/1 ",                 "method" : "POST"            }     } }

위와 같은 예시에서는 아메리카노 설명을 보고 아메리카노를 주문할 수 있는 링크를 삽입하거나 주문이 완료 된 후 주문을 확인 할 수있도록 링크를 작성해 넣을 수 있음 . 이렇게 응답에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트임 .