빡코딩 레쓰기릿
REST API
- 웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, http 프로토콜을 통해 요청과 응답을 정의하는 방식을 말합니다.
만약 레스토랑의
메뉴판이 위와 같다면, 알아보기도 어렵고 주문하기도 어렵다.
클라이언트와 서버는 서로 데이터와 리소스를 요청하고, 요청에 따른 응답을 전달하기 위한 메뉴판 (API)이 필요합니다. 클라이언트는 식사를 주문하듯 서버에 요청하고, 이에 대한 응답을 메뉴판에 있는 사진이나 음식에 대한 설명처럼 다시 서버에서 클라이언트로 전송하게 됩니다.
따라서 알아보기 쉽고 잘 작성된 메뉴판이 필요합니다.
이 필요를 진작에 눈치채고 api 설계 템플릿을 논문화 하신 분이 로이 필딩(Roy Fielding)입니다.
그리고 이 설계 템플릿에 맞춰 작성된 api를 우린 REST(Representational State Transfer) API라고 합니다.
REST 성숙도 모델
- 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해
레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었습니다. 실제로는 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API 라고도 부릅니다.
성숙도 모델 0단계
성숙도 모델에 따르면, 0단계에서는 단순히 http프로토콜을 사용하기만 해도 됩니다. 물론 이 경우, 해당 api를 rest api라 할 순 없고, 단지 rest api 작성을 위한 기본 단계라 생각하면 됩니다.
성숙도 모델 1단계
- 1단계에서는 개별 리소스와의 통신을 준수해야 합니다.
쉽게 말하면, 앞서 REST API는 웹에서 사용되는 모든 데이터나 자원을 http url로 표현한다고 이야기 했습니다. 따라서 모든 자원은 개별 리소스에 맞는
엔드포인트를 사용해야하며, 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심입니다.
성숙도 모델 2단계
- CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둡니다.
예를 들면 조회(READ)하기 위해서는 GET 메서드를 사용하여 요청을 보내고, 이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달합니다.
Create은 PUT 메서드를
Read는 GET 메서드를
Update는 PUT과 PATCH 메서드를 (하지만 PUT 은 교체 PATCH 는 수정을 용도로 사용합니다.)
Delete은 Delete 메서드를 사용합니다
성숙도 모델 3단계
- 마지막 단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용합니다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 합니다.
- 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트입니다.
- 만약 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있습니다.
Open API
-
정부에서 제공하는 공공데이터가 있습니다. 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있습니다. 공공데이터 포털에 접속해 원하는 키워드를 검색하면, 해당 키워드와 관련된 API를 확인할 수 있습니다.
-
이 API에는 "Open"이라는 키워드가 붙어 있습니다. 글자 그대로 누구에게나 열려있는 API입니다. 그러나 "무제한으로 이용할 수 있다"라는 의미는 아닙니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있습니다.
-
Open API를 간단하게 경험해 볼 수 있는 대표적인 페이지는, Open Weather Map이라는 웹 사이트에서 제공하는 날씨 API 입니다. 이 웹사이트에서는 다음의 설명처럼 데이터를 제공합니다.
- 제한적이나마 무료로 날씨 API를 사용할 수 있습니다.
1-1. 프리 플랜에서는 기본적으로 분당 60번, 달마다 1백 번 호출이 가능합니다. - 데이터를 JSON 형태로 응답합니다.
- 제한적이나마 무료로 날씨 API를 사용할 수 있습니다.
API Key
API를 이용하기 위해서는 API Key가 필요합니다. API key는 서버의 문을 여는 열쇠입니다. 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없습니다. (가끔 API key가 필요하지 않은 경우도 있습니다.)
API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있습니다.
