클라이언트와 서버의 통신을 담당하는 API는 어떻게 작성해야 할까?
구글이나 Microsoft 같은 대형 IT 기업은 API를 어떻게 작성하고 있을까?
만약 혼자서 웹사이트를 만들고 관리한다면, API를 어떻게 설계하고 구현하든 상관이 없다. 그러나 일반적인 회사에서 진행하는 서비스 개발은 대부분 팀 단위로 진행한다. 그렇기에 사소한 것 하나라도 규칙(rule)이 있어야 소통이 원활하다.
이번에는 API의 대표적인 아키텍처인 REST API를 알아보고, Postman으로 HTTP 요청을 직접 실습(API 테스팅) 해보자.
REST API 개요
웹 애플리케이션에서는 HTTP 메서드를 이용해 서버와 통신한다.
GET을 통해 웹 페이지나 데이터를 요청하고, POST로 새로운 글이나 데이터를 전송하고, DELETE로 저장된 글이나 데이터를 삭제할 수 있다. 이처럼 클라이언트와 서버가 HTTP 통신을 할 때는 어떤 요청을 보내고 받느냐에 따라 메서드의 사용이 달라진다.
이런 사용은 아무런 규칙 없이 이루어지는 것이 아니다. 요청과 응답을 할 때, '제대로 보내고 받을 수 있는' 일종의 규약이 존재한다.
REST API Design
REST API 에서 REST는 Representational State Transfer의 약자로, 로이 필딩Roy fielding의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었다.
REST API는 웹에서 사용되는 데이터나 자원resource를 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.
클라이언트와 서버 사이에도 데이터와 리소스를 요청하고, 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다. 이 메뉴판을 보고 클라이언트는 식당에서 식사를 주문하듯 서버에 요청하고, 이에 대한 응답을 메뉴판에 있는 사진이나 음식에 대한 설명처럼 다시 서버에서 클라이언트로 전송하게 된다.
따라서 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요한데, 이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요하다.
REST API를 디자인하는 방법
REST API를 작성할 때는 몇 가지 지켜야 할 규칙들이 있다. 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.
REST 성숙도 모델은 총 4단계로 나누어진다.
앞서 이야기한 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했다. 그러나 실제로 엄밀하게 3단계까지 지키기는 어렵고 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있다.
이런 경우를 HTTP API라고도 부른다.
REST 성숙도 모델 - 0단계
REST 성숙도 모델에 따르면, 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다.
물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계이다.
허준이라는 이름의 주치의의 예약 가능한 시간을 확인하고, 어떤 특정 시간에 예약하는 상황을 예로 들어보자.
위 예시에서는 HTTP 프로토콜을 사용하고 있는 것을 확인할 수 있다. 이렇듯 단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.
REST 성숙도 모델 - 1단계
REST 성숙도 모델 1단계를 이해하고 나면 앞의 0단계에서 들었던 API를 조금 더 적절하게 바꿀 수 있다.
1단계에서는 개별 리소스와의 통신을 준수해야한다.
조금 더 쉽게 말하면, 앞서 REST API는 웹에서 사용하는 모든 데이터나 자원을 HTTP URI로 표현한다고 했다. 따라서 모든 자원은 개별 리소스에 맞는 앤드포인트를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다.
앞서 0단계에서는 요청에서의 앤드포인트로 모두 /appointment를 사용했다. 하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 앤드포인트로 구분하여 사용한다.
위의 예시에서 예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원은 허준이라는 의사의 예약 가능한 시간대이다. 그렇기 때문에 요청 시 /doctors/허준이라는 엔드포인트를 사용한 것을 볼 수 있다. 그 뿐만 아니라, 특정 시간에 예약하게 되면, 실제 slots라는 리소스의 123이라는 id를 가진 리소스가 변경되기 때문에, 하단의 특정 시간에 예약이라는 요청에서는 slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용하였다.
예시와 같이, 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드 포인트르 작성하는 것이 중요하다.
앤드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.
더불어 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다. 예를 들어, 김코딩 환자가 허준에게 9시에 예약을 진행하였으나 해당 시간이 마감되어 예약이 불가능하다고 가정할 때, 위와 같이 리소스 사용에 대한 실패 여부를 포함한 응답을 받아야 한다.
성숙도 모델 - 2단계
REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 앞서 0단계와 1단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메서드를 사용하고 있다. 그러나 REST 성숙도 모델 2단계에 따르면, 이는 CRUD에 따른 적합한 메서드를 사용한 것이 아니다.
먼저 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(Read) 하는 행위, 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(Create) 한다는 것과 같다.
그렇기 때문에 조회(Read)하기 위해서는 GET 메서드를 사용하여 요청을 보내고, 이때 GET메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다.
(what is query parameter = ? )
또한 예약을 생성(Create)하기 위해서 POST 메서드를 사용하여 요청을 보내야 하며, POST 요청에 대한 응답이 어떻게 반환되는지가 중요하다. 이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created로 명확하게 작성해야 하며, 관련 리소스를 클라인트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 완벽하게 REST 성숙도 모델 2단계를 충족한 것이라고 볼 수 있다.
HTTP 메서드를 사용할 때 몇가지 규칙에도 유의해야 한다.
GET메서드 같은 경우는 서버으 ㅣ데이터를 변화시키지 않는 요청에 사용해야 한다.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를 포함한 링크 요소를 삽입하여 작성해야 한다.
이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼 미디어 컨트롤을 포함하고 있다.
예를 들어 위와 같이 허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인 할 수 있도록 리크를 작성해 넣을 수도 있다. 이렇게 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트이다.
만약 클라이언트 개발자들이 응답에 담겨있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근 할 수 있게 하는 요소가 될 수 있다.
Open API 와 API Key
개념
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를 같이 전달해야 원하는 응답을 받을 수 있다.
