44장 REST API

REST 란

HTTP의 장점을 최대한 활용할 수 있는 아키텍처로서 REST(REpresentational State Transfer)가 나오게 되었고, HTTP 프로토콜을 의도에 맞게 디자인하도록 유도하고 있다. REST의 기본 원칙을 잘 지킨 서비스 디자인을 RESTful이라고 표현한다.

REST는 HTTP를 기반으로 클라이언트가 서버의 리소스에 접근하는 방식을 규정한 아키텍처고, REST API는 REST를 기반으로 서비스 API를 구현한 것이다.

REST API 구성

REST API는 자원(resource), 행위(verb), 표현(representations)의 3가지 요소로 구성된다.

👉 자원 : URI(엔드포인트)로 표현한다
👉 행위: 자원에 대한 행위로서, HTTP 요청 메서드로 표현한다.
👉 표현 : 자원에 대한 구체적인 내용으로서, 페이로드를 통해 표현한다.

REST API 설계 원칙

1. URI는 리소스를 표현해야 한다.

리소스를 식별할 수 있는 이름은 동사보다는 "명사"를 사용한다. 이름에 get 같은 행위에 대한 표현이 들어가서는 안 된다.

# bad
GET /getTodos/1
GET /todos/show/1

# good
GET /todos/1

2. 리소스에 대한 행위는 HTTP 요청 메서드로 표현한다.

HTTP 요청 메서드는 클라이언트가 서버에게 요청의 종류와 목적을 알리는 방법이다. 주로 5가지 요청 메서드를 사용해 CRUD를 구현한다.

HTTP 메서드 / 그림출처: poiemaweb

# bad
GET /todos/delete/1

# good
DELETE /todos/1

즉, 리소스를 취득하는 경우에는 GET을, 리소스를 삭제하는 경우에는 DELETE를 사용해 리소스에 대한 행위를 명확히 표현한다.