REST API란

REST는 Representational State Transfer의 약자로
웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로서,
REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.

즉 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 홈페이지가 필요한데, 이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요합니다.

REST API를 디자인하는 방법

• 0단계 : HTTP사용
• 1단계 : 개별 리소스와의 통신 준수
• 2단계 : HTTP 메소드 원칙 준수
• 3단계 : HATEOAS 원칙 준수

성숙도 모델로 총 4단계로 나누어진다
실제로 3단계까지 적용시키긴 매우 어려우며, 2단계까지만 사용해도 충분히 좋은 API디자인이라고 볼수 있다.
이를 HTTP API라고 부른다

성숙도 모델 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 되며, 이 경우 당연히 REST API라 할 수 없으며, 작성하기 위한 기본 단계라고 보면 된다.

성숙도 모델 1단계

1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다
즉 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다

성숙도 모델 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다

• C : Create
• R : Read
• U : Update
• D : Delete

HTTP 메서드 사용 규칙

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

성숙도 모델 3단계

3단계에서는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다

3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다

이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

OPEN API

"Open"이라는 키워드는 글자 그대로 누구에게나 열려있는 API다
그러나 "무제한으로 이용할 수 있다"라는 의미는 아니며, API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다

API Key

API를 이용하기 위해서는 API Key가 필요하며, API Key는 서버의 문을 여는 열쇠로 활용된다고 보면 된다
서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건없이 임경의 클라이언트에게 데이터를 제공할 의무는 없다.

API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있다