REST API

🌐

REST API

REST API 성숙도 모델

0단계 : HTTP 프로토콜 사용

1단계 : 개별 리소스와의 통신 준수

2단계 : HTTP 메서드 원칙 준수

3단계 : HATEOAS 원칙 준수

Open API

API Key

REST API

REST API에서 REST는 Representational State Transfer의 약자로, 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고 HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 의미한다.

HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고 받기 위해서는 API를 알아보기 쉽게 잘 작성하는 것이 중요하다. REST는 이를 위한 리소스 중심의 일종의 방법론이자 아키텍처(API를 설계하고 구축하는데 사용하는 패턴과 기술)이라 볼 수도 있다. 즉, REST를 이용해 작성된 API가 REST API인 것이다.

REST API 성숙도 모델

REST API를 작성할 때는 몇 가지 지켜야 할 규칙이 있고, 레오나르드 리차드슨(Leonard Richardson)은 이를 잘 적용하기 위한 4단계 모델을 제시했다. 이를 REST API 성숙도 모델이라 한다.

REST 성숙도 모델은 0~3단계까지 총 4단계로 나누어지고, 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 일반적으론 2단계까지만 적용해도 좋은 API 디자인이라 볼 수 있다. 이런 경우를 HTTP API라고 부르기도 한다.

0단계 : HTTP 프로토콜 사용

0단계는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 물론 이 단계에서 해당 API를 REST API라 부를 순 없고, REST API를 작성하는 기본 단계로 이해하면 된다. 아래의 예시는 예약을 위한 어플리케이션이 서버와 통신하는 상황이라 가정한다.

단순히 HTTP 프로토콜을 사용하는 것이 0단계이자 REST API의 출발점이다.

1단계 : 개별 리소스와의 통신 준수

1단계는 개별 리소스(Resource)와의 통신을 준수해야 한다. 앞서 설명한 REST의 정의에 따르면 데이터나 자원(Resource)을 HTTP URI로 표현한다고 했다. 따라서 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하고 요청하고 받는 자원에 대한 정보를 응답으로 전달하는 것이 1단계의 핵심이다.

0단계와 비교했을 때 각 요청의 엔드포인트에 변화가 있으며, 실제 변경되는 리소스인 ‘123’ slot을 엔드포인트로 사용했다

위의 예시처럼 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에 적절한 엔드포인트를 작성하는 것이 중요하다. 엔드포인트 작성 시에는 동사, HTTP 메서드, 어떤 행위에 대한 단어 사용은 지양하고 리소스에 집중해 명사 형태의 단어를 작성하는 것이 바람직하다.

이와 함께, 요청에 따른 응답으로 리소스를 전달할 때 사용한 리소스에 대한 정보와 더불어 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

이미 예약이 되어있는 상황이라 예약이 불가능하여 실패 여부를 포함한 응답을 받았다

2단계 : HTTP 메서드 원칙 준수

2단계는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 포커스를 둔다. 0단계와 1단계의 예시는 모두 POST 메서드를 사용하고 있지만, 2단계에 따르면 이는 CRUD에 맞는 적합한 메서드를 사용한 것이 아니다.

필요한 행위에 따른 적절한 메서드를 사용해 요청을 보낸다

예시를 기준으로, 예약 가능한 시간을 확인하는 것은 조회(READ)하는 행위이기 때문에 조회는 GET 메서드로 요청을 보내고, GET메서드는 body를 가지지 않기 때문에 query parameter를 사용해 필요한 리소스를 전달한다.

예약을 하는 것은 예약을 생성(CREATE)하는 것이므로 POST메서드를 사용해야 하며, POST요청에 따른 응답 역시 중요하다. 이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에 응답코드는 201 Created로 명확하게 작성되어야 하고 이와 함께 Location헤더에 관련 리소스의 URI를 함께 응답하므로 성숙도 모델 2단계를 충족한 것이라 볼 수 있다.

HTTP 메서드를 사용할 때 몇 가지 규칙에도 유의하자.

• GET메서드의 경우 READ이므로 서버의 데이터를 변화시키지 않는 요청에 사용한다.

• POST메서드는 요청마다 새로운 리소스를 생성하지만 PUT메서드는 요청마다 같은 리소스를 반환한다. 이렇게 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 부르며, 멱등성을 가지는 메서드 PUT과 그렇지 않은 POST는 구분해야 한다.

• PUT과 PATCH도 구분해서 사용해야 한다. 같은 UPDATE이지만 PUT은 교체, PATCH는 수정의 용도로 사용한다.

3단계 : HATEOAS 원칙 준수

3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다. 이때 응답에 들어가는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함한다. 이는 클라이언트 개발자들이 응답에 담긴 링크를 통해 조금 더 쉽고 효율적으로 리소스와 기능에 접근하게끔 하는 요소가 된다.

요청은 같지만, 응답에서 하이퍼링크를 제공하면서 추가적인 액션(예약, 예약취소)을 할 수 있는 링크를 포함해 작성한다.

☝🏼

API를 작성할 때, 2단계까지 적용하면 대체적으로 잘 작성된 API라 부를 수 있다. REST를 처음 정의하고 소개한 로이 필딩은 3단계까지 만족하지 못하면 REST가 아닌 HTTP API로 불러야 한다 주장하지만, 모범적인 API 디자인 조차 3단계까지 적용한 경우는 드물기 때문에 3단계까지 무조건적으로 적용해야 하는 것은 아니다.

Open API

Open API는 말 그대로 누구에게나 열려있는 API를 뜻한다. 단, 무제한으로 이용이 가능한 것이 아닌 API마다 정해진 이용 수칙이 있고 이에 따른 제한사항(가격, 정보의 제한 등)이 있을 수 있다. Open API의 대표적인 예로는 정부에서 제공하는 공공데이터 포털, 네이버에서 제공하는 네이버 오픈 API가 있다.

API Key

서버를 운용하는 데에는 비용이 발생하기 때문에 서버 입장에서는 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무가 없다. 그래서 일반적으로 API를 이용하기 위해서는 API Key가 필요하다. (가끔 API Key가 필요하지 않는 경우도 존재한다)

서버쪽에서는 자원에 접근할 수 있는 권한을 API Key 형태로 제공하고, 클라이언트 쪽에서는 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있는 방식이다.

Uploaded by N2T