REST API

REST는 "Representational State Transfer"의 약자.

로이 필딩(Roy Fielding)의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개.

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

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

REST API를 디자인하는 방법

로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르도 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

REST 성숙도 모델은 총 4단계(0~3단계).

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다.

이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계.

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

REST 성숙도 모델 - 1단계

1단계에서는 개별 리소스(Resource)와의 통신을 준수.

앞서 REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현한다고 이야기.

모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.

어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요.

엔드포인트 작성 시에는, 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법.

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

REST 성숙도 모델 - 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용.

GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달.

POST 요청에 대한 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created로 명확하게 작성, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인.

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

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API.

REST 성숙도 모델 - 3단계

마지막 단계는 HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용.

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

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

응답 내에 새로운 링크를 넣어 새로운 기능에 접근.

Open API

공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공.

"Open"이라는 키워드는 글자 그대로 누구에게나 열려있는 API.

"무제한으로 이용할 수 있다"라는 의미는 아니다.

API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.

API Key

API key는 서버의 문을 여는 열쇠.

서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없다.

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