Network

REST API

WY J 2022. 8. 3. 23:39

REST API란?

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

REST API는 웹에서 사용되는 데이터나 자원(Resource)를 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다. 쉽게 말해서, 개발자가 서로 다른 애플리케이션끼리 프로그래밍 방식으로 통신할 수 있도록 규칙을 정의한 것이다.

 

비유하자면,

클라이언트와 서버 사이에도 데이터와 리소스를 요청하고 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다.

이 메뉴판을 보고 클라이언트는 식당에서 식사를 주문하듯 서버에 요청하고, 이에 대한 응답을 메뉴판에 있는 설명처럼 다시 서버에서 클라이언트로 전송하게 된다. 메뉴판과 마찬가지로 API도 알아보기 쉽게 잘 작성되어야 한다.

 

 

 

좋은 REST API를 디자인하는 방법

 

레오나르드 리차드슨은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

 

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 해당 API를 REST API라고 할 순 없지만, 기본적인 단계이다.

 

 

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

 

 

 

REST 성숙도 모델 - 1단계

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

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

 

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

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

예약 가능한 시간 확인 -> /doctors/허준 이라는 엔드포인트를 사용한 것을 볼 수 있다.

특정 시간에 예약 -> /slots/123 이라는 엔드포인트를 사용하여, 리소스의 123이라는 id를 가진 리소스가 변경하여 예약한다.

 

어떤 리소스를 제공하는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트 작성이 필요하다.

 

 

 

REST 성숙도 모델 - 2단계

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

 

앞의 단계에서는 모든 요청을 CRUD에 상관없이 POST로 하고 있다. 그러나 CRUD에 따른 적합한 메서드를 사용한 것은 아니다.

예약 시간을 확인하는 것은 GET 메서드를 사용하며, body를 가지기 않기 때문에 query parameter를 사용하여 리소스를 전달해야 한다.

예약을 생성하는 것은 POST 메서드를 사용하여 요청을 보내고, 201 Created로 정확히 응답해주어야 한다.

 

 

메서드 사용 규칙

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

 

REST 성숙도 모델 - 3단계

3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.

3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 다르다.

 

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

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

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

 

 

 

HTTP STATUS code

  • 2XX - 성공
  • 3XX - 리다이렉션 메세지
  • 4XX - 클라이언트 요청 오류
  • 5XX - 서버 내부 오류