REST API

REST API

• 웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고 HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식
• REST: Representational State Transfer의 약자, 로이 필딩의 박사학위 논물에서 웹의 장점을 최대한 활용할 수 있는 아키텍처로 처음 소개\

내가 카페 손님이라고 가정했을 때, 음료를 주문하려고 한다. 만약 메뉴판의 상태가 알아보기 어렵고, 주문하기 어렵다면 주문을 할 수 없지 않을까? 이와 같이 클라이언트와 서버 사이에서도 데이터와 리소스를 요청하고, 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다. 따라서 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요하다는 것이다.

REST API를 디자인하는 방법

• REST API를 작성할 때 지켜야 할 규칙
  
• 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장하였으나 실제로는 3단계까지는 지키기 어렵기 때문에 2단계까지 충족해도 좋은 API 디자인이라고 볼 수 있으며 이러한 경우를 HTTP API라고도 부른다.

REST 성숙도 모델

- 0단계 [HTTP 사용]

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

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

위와 같이 HTTP 프로토콜을 사용하는 것을 확인할 수 있다! HTTP 프로토콜을 사용하는 것은 REST API의 출발점이다.

- 1단계 [개별 리소스와의 통신 준수]

• 웹에서 사용되는 모든 데이터, 자원을 HTTP URI로 표현한다. 이는 모든 자원이 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것이다. 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 핵심이다.

💡 0단계에서의 요청에서 Endpoint로 모두 /appointment를 사용했다. 하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 Endpoint로 구분하여 사용한다.

• 위의 예시에서 예약 가능한 시간 확인이라는 요청 응답으로 받게 되는 자원은 "허준"이라는 의사의 예약 가능한 시간대이다. 그렇기 때문에 요청 시 /doctors/허준 이라는 Endpoint를 사용한 것을 확인할 수 있다. 뿐만 아니라 특정 시간에 예약하게 되는 slots 라는 리소스의 123 이라는 id를 가진 리소스가 변경되기 때문에, 특정 시간 예약이라는 요청에서는 /slots/123 으로 실제 변경되는 리소스를 Endpoint로 사용했다.
• 예시와 같이 어떤 리소스를 변화시키는지, 어떤 응답이 제공되는지에 따라서 각기 다른 Endpoint를 사용하기 때문에 적절한 Endpoint를 작성하는 것이 중요하다. Endpoint 작성 시, 동사, HTTP 메서드, 어떤 행위에 대한 단어 사용을 지양하고, 리소스에 집중해서 "명사" 형태의 단어로 작성하는 것이 바람직하다.

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

김코딩 환자가 허준 의사에게 9시 예약을 진행했으나, 해당 시간이 마감되어서 예약이 불가할 때 위와 같이 리소스 사용에 대한 실패 여부를 포함하고 있는 응답을 받아야 한다.

- 2단계 [HTTP 메소드 원칙 준수]

• CURD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 0, 1단계 예시에서 모든 요청을 CURD에 상관없이 POST 메서드를 사용하고 있었다. 그러나 REST 성숙도 모델 2단계에 따르면 이는 올바른 CURD에 따른 적합한 메서드를 사용한 것은 아니다.

• 예약 가능한 시간 확인은 예약할 수 있는 시간을 조회(READ)하는 행위를 의미하고, 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)하는 것과 같다. 조회는 GET 메서드를 사용하여 요청을 보내고, 이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용해 필요한 리소스를 전달한다.

• 예약 생성은 POST 메서드를 사용하여 요청을 보내야 하며, POST 요청에 대한 응답이 어떻게 반환되는지가 중요하다. 이러한 경우의 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created 로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있다.

💥 HTTP 메서드 사용 시 유의할 점

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

- 3단계 [HATEOAS 원칙 준수]

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

• 위와 같이 "허준"이라는 의사의 예약 가능 시간을 확인한 후, 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료 후 그 예약을 다시 확인할 수 있도록 링크를 작성해서 넣을 수 있다. 특정 시간에 예약한 곳의 응답을 보면 내가 예약을 오나료하고 다시 예약을 확인하려면 조회하여야 하므로 조회할 수 있는 곳의 링크와 HTTP 메서드로 GET 메서드를 사용하고 있다. 그리고 만약 예약한 것을 취소할 수 있는 경우가 있으므로 해당 예약 취소로 DELETE 메서드를 사용한 것을 확인할 수 있다. 이와 같이 응답 내에 새로운 링크를 넣어서 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트이다.

---

Open API

• 정부에서 제공하는 공공데이터가 있다. 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API 형태로 공공데이터를 제공하고 있다. 공공데이터 포털 사이트에 접속하여 원하는 키워드를 검색하면, 해당 키워드와 관련된 API를 확인할 수 있다.

🔎 공공데이터 포털 사이트

• "Open"이라는 키워드가 붙어 있듯이 이는 누구에게나 열려 있는 API이다. 하지만 무제한으로 이용할 수 있다는 의미는 아니므로 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항이 있을 수 있다.

• 아래 사이트를 통해 Open Weather Map이라는 웹 사이트에서 제공하는 날씨 API를 사용해 무료로 날씨 API를 사용해 보자! 이 날씨 API는 데이터를 JSON 형태로 응답한다.

🔎 Open API를 간단하게 경험해 볼 수 있는 대표적인 페이지

API Key

• API를 이용하기 위해서는 "API Key"가 필요하다. 이는 서버의 문을 여는 열쇠로, 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무가 없다. 가끔은 API key가 필요하지 않은 경우도 있지만 필요한 경우에는 로그인한 이용자에게 자원을 접근할 수 있는 API key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있다.