REST API
<학습 목표>
- REST API의 이해
- REST API 성숙도 모델에 대한 이해
- REST API 문서 읽기
- REST API에 맞춰 디자인
- Open API 와 API Key에 대한 이해
<API 란?>
응용 프로그램에서 사용할 수 있도록 운영체제나 프로그래밍 언어에서 제공하는 기능을 제어할 수 있게 해주는 인터페이스 즉, 어플리케이션 간에 지정된 형식으로 요청과 응답을 할 수 있도록 연결해주는 기능을 한다.
<REST API 란?>
웹에서 사용되는 데이터나 자원을 HTTP URL로 표현하고, HTTP프로토콜을 통해 요청이나 응답을 정리해 주는것으로 각 요청이 어떤 정보나 동작을 위한 것인지 그 모습 자체로 추론이 가능하게 짜는 것이 좋다!
<REST API를 디자인하는 방법>
리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다. 그는 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했다. (실제로는 2단계 까지만 적용해도 좋은 API로 인정하고 이를 HTTP API라고 한다.)
- REST 성숙도 모델 0단계
0단계에서는 REST API를 작성하기 위한 기본 단계이며, 단순히 HTTP 프로토콜을 사용하기만 해도 된다. (그렇다고 이게 REST API라고 할 순 없음… 그냥 준비 단계라 생각하자)
- REST 성숙도 모델 1단계
1단계에서는 개별 리소스와의 통신을 준수해야 한다. REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현한다고 했는데, 즉 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다.
- REST 성숙도 모델 2단계
REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 앞선 0단계, 1단계에서 POST메서드를 사용했다면 2단계는 CRUD(Create, Read, Update, Delete)에 따른 적합한 메서드를 사용해야 한다
+ HTTP 메서드를 사용할 때 유의해야 할 규칙
- GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다,
- POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 “멱등하다”라고 한다. 그래서 멱등성을 가진 메서드 PUT과 그렇지 않은 메서드 POST는 구분해서 사용해야 한다.
- PUT(교체) 메서드와 PATCH(수정) 메서드도 구분해서 사용해야 한다.
- REST 성숙도 모델 3단계
마지막 3단계는 HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다. 이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액선들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.(응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트!)
<Open API 와 API Key>
-
Open API : 글자 그대로 누구에게나 열려있는 API이다. 그러나 이 말이 무제한으로 이용 가능이란 말은 아니다. API마다 정해진 이용 수칙이 있고, 거기에 따른 제한사항(가격, 정보의 제한 등등)이 있을 수 있다.
-
API Key : API를 이용하기 위해서는 API Key가 필요하다. API Key는 서버를 여는 열쇠이며 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무론 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없다.(API Key가 필요 없는 경우도 종종 있긴함…) API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있다.
