[리뷰] REST API

REST API

REST API (Representational State Transfer Application Programming Interface)

• 웹의 장점을 최대한 활용할 수 있는 아키텍쳐
• 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식

리차든의 REST 성숙도 모델

모든 단계를 충족해야 REST API라고 부를 수 있다고 주장하지만 엄밀히 말해서 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이며, 이런 경우를 HTTP API라고 부른다

---

REST 성숙도 모델 - 0단계

REST 성숙도 모델에 따르면, 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 이 경우의 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계이다.

---

REST 성숙도 모델 - 1단계

REST 성숙도 모델에 따르면, 1단계에서는 개별 리소스(Resource) 와의 통신을 준수해야 합니다. REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현한다. 따라서 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다.

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

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

---

Rest 성숙도 모델 2단계

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

0,1 단계는 모든 요청을 POST 메서드를 사용하고 있다.

GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다. 또한 서버의 데이터를 변화시키지 않는 요청에 사용한다

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

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

PUT 메서드와 PATCH 메서드도 구분하여 사용해야 하며 PUT은 교체, PATCH는 수정의 용도로 사용한다.

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다. 물론 로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한 API는 REST API가 아닌 HTTP API라고 불러야 한다고 주장하지만, 앞으로 여러분들이 개발자로서 보시게 될 모범적인 API 디자인조차도 REST 성숙도 모델의 3단계까지 적용한 경우는 드물다. 따라서 3단계까지 무조건적으로 모두 적용해야 하는 것은 아니다.

---

REST 성숙도 모델 - 3단계

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

이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다. 즉 , 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 핵심이다.

---

Open API

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

Open API를 간단하게 경험해 볼 수 있는 대표적인 페이지는, Open Weather Map이라는 웹 사이트에서 제공하는 날씨 API다. 이 웹사이트에서는 다음의 설명처럼 데이터를 제공한다

• 제한적이나마 무료로 날씨 API를 사용할 수 있다.
  • 프리 플랜에서는 기본적으로 분당 60번, 달마다 1백 번 호출이 가능하다.
• 데이터를 JSON 형태로 응답한다.

---

API Key

API를 이용하기 위해서는 API Key가 필요하다. API key는 서버의 문을 여는 열쇠다. 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없다. (가끔 API key가 필요하지 않은 경우도 있다.)

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

실제 경험에 따르면 naver Open API를 사용한 적이 있는데, 그때도 KEY를받아 인증하고 사용했다.

 

POSTMAN을 사용하여 쉽게 API를 테스트할 수 있다.