REST API란?

REST(Representational State Transfer) - 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.

API - 프로토콜 집합을 사용하여 두 소프트웨어 구성 요소가 서로 통신하여 정보들을 주고받을 수 있게 하는 메커니즘이다.

REST API - HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다. 쉽게 말해 REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현하는 것이다.

REST API 디자인

REST 성숙도 모델(0~3)

Level 0

오직 HTTP를 원격 호출하기 위한 전송 시스템으로 사용된다.
그러므로, REST API라고 할 수 없으며, Resource 구분없이 설계된 HTTP API라고 할 수 있다. 또한, 하나의 End-point를 사용해서 HTTP Method도 반드시 POST가 된다.

POST /api/user
{
  "function": "getUser",
  "arguments" [
    "1"
  ]
}

Level 1

Resource 개념이 도입된다. 모든 요청을 Level0과 다르게 개별 Resource를 통해서 전달된다. 개별 Resource에 맞는 엔드포인트(End-point)를 사용해야한다. 따라서 요청을 하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.

위 사진을 보면 요청 시 응답으로 받는 Resource는 허준이라는 의사의 예약 가능한 시간대이다. 그러므로 요청 시/doctors/허준이라는 엔드포인트(End-point)를 사용했다. 이와 같이 어떤 Resource를 변화시키고 응답이 제공되는지에 따라 다른 엔드포인트(End-point)를 사용하기 때문에 적절한 엔드포인트(End-point)를 작성하는 것이 중요하다. 또한, 엔드포인트(End-point)는 리소스는 동사보다는 명사를, 대문자보다는 소문자를 사용하는 것이 좋다.

Level 2

CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 0단계 1단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메서드를 사용하고 있다.

위 사진 처럼 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(READ) 하는 행위를 의미하고, 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE) 한다는 것과 같다. 그러므로 조회(READ)하기위해 GET을 썼고, 예약을 생성하기 위해 POST 를 사용했다. 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created 로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있다.

자주 사용되는 HTTP 메서드의 종류를 알아보자.
GET - resource read
delete - resource delete
post - resource 생성
put - resource 교체
patch - resource 일부를 수정

Level 3

3단계는 2단계와 동일하지만, HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용해야한다. 응답에 리소스의 URI를 포함한 링크 요소를 삽입해야한다. 이때 응답에 들어가는 링크 요소는 응답을 받은 후 다양한 액션들을 위한 하이퍼미디어 컨트롤(하이퍼미디어는 서버가 클라이언트에게 나중에 어떤 HTTP 요청을 보낼 수 있을지 설명하는 방식)을 포함하고 있다.

위와 사진처럼 허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다. 이렇게 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계 핵심이다. 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있다.