REST API 개요
REST API에서 REST는 “Representational State Transfer”의 약자이며 웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식이다.
REST API 디자인
REST API 작성할 때는 몇 가지 규칙으로 4단계 성숙도 모델이 있다.
위의 성숙도 모델은 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API 라고도 부른다.
REST 성숙도 모델 - 0단계
단순히 HTTP 프로토콜을 사용하는 것만으로 REST API라고 할 수 없으며 단순히, REST API의 출발점이라고 생각하면 된다.
REST 성숙도 모델 - 1단계
REST 성숙도 모델에 따르면, 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다. 쉽게 설명하면, 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.
때문에 적절한 엔드포인트 작성이 중요하며 동사, HTTP메서드, 행위에 대한 단어는 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 좋은 방법이다.
REST 성숙도 모델 - 2단계
REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
HTTP 메서드를 사용할 때 몇가지 규칙에도 유의하셔야 합니다.
- GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
- POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 하고 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 한다.
- PUT은 교체, PATCH는 수정의 용도로 사용한다.
REST 성숙도 모델 - 3단계
마지막 단계는 HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용해야 한다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.
Open API
누구에게나 열려있는 API라는 의미이지만 무제한으로 이용할 수 있다는 의미는 아니다. API마다 정해진 이용수칙이 있고, 그 이용 수칙에 따라 제한사항이 있을 수 있다.
API Key
API를 이용하기 위해서는 API Key가 필요하다. API Key는 서버의 문을 여는 열쇠같은 용도로, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있다.
