REST API
REST란, Representational State Transfer"의 약자로 REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식이다.
이 URI은 만드는 사람이 원하는대로 만들 수 있지만, 지켜야하는 규칙이 있다.
REST API를 디자인하는 방법
로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.
리차드슨의 REST 성숙도 모델을 구조화하면 다음과 같다.
REST 성숙도 모델은 총 4단계(0~3단계)로 나누어진다.
앞서 이야기한 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했다. 그러나 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API 라고도 부른다.
REST 성숙도 모델 - 0단계
HTTP 프로토콜을 사용하기만 해도 된다.
매개 변수를 body로 전달하기 위해 HTTP method는 POST
REST 성숙도 모델 - 1단계
요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용한다.
엔드포인트 : /doctors, /slots 같은거
엔드포인트 작성 시, 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성한다.
요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환한다.
REST 성숙도 모델 - 2단계
2단계에서는CRUD(Create, Read, Update, Delete) 에 따른 적합한 HTTP메서드를 사용한다.
HTTP 메서드에서 확인할 수 있다.
GET메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.POST메서드는 요청마다 새로운 리소스를 생성하고PUT메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 한다.PUT메서드와PATCH메서드도 구분하여 사용해야 한다.PUT은 교체,PATCH는 수정의 용도로 사용한다.
REST 성숙도 모델 - 3단계
마지막 단계는 HATEOAS(Hypermedia As The Engine Of Application State) 라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.
이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.
만약 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있다.
Open API
공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있다. 공공데이터 포털에 접속해 원하는 키워드를 검색하면, 해당 키워드와 관련된 API를 확인할 수 있다.
이 API에는 "Open"이라는 키워드가 붙어 있는데, 글자 그대로 누구에게나 열려있는 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를 같이 전달해야 원하는 응답을 받을 수 있다.
