[Deep Dive] REST API

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

이러한 REST의 기본 원칙을 성실히 지킨 서비스 디자인을 "RESTful"이라고 한다.

 

REST API의 구성

REST API는 자원, 행위, 표현의 3가지 요소로 구성된다. REST는 자체 표현 구조로 구성되어 REST API만으로 HTTP 요청의 내용을 이해할 수 있다.

구성 요소	내용	표현 방법
자원	자원	URI (엔드포인트)
행위	자원에 대한 행위	HTTP 요청 메서드
표현	행위의 구체적 내용	페이로드

 

 

REST API 설계 원칙

REST에서 가장 중요한 기본 원칙은 두 가지가 있다.

1. URI는 리소스를 표현하는데 집중해야하며 행위에 대한 표현이 들어가면 안된다.
2. 행위에 대한 정의는 HTTP 요청 메서드를 통해 한다.

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

URI는 리소스를 표현하는데 중점을 두며, 리소스를 표현하는 이름은 명사를 사용한다.

행위에 대한 표현이 들어가서는 안된다.

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

#good
GET /todos/1

 

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

HTTP 요청 메서드는 클라이언트가 서버에게 요청의 종류와 목적을 알리는 방법이다.

GET, POST, PATCH, DELETE 등을 이용해 CRUD를 구현한다.

 

HTTP 요청 메서드	종류	목적	페이로드
GET	index/retrieve	모든/특정 리소스 취득	X
POST	create	리소스 생성	O
PUT	replace	리소스의 전체 교체	O
PATCH	modify	리소스의 일부 교체	O
DELETE	delete	모든/특정 리소스 삭제	X

 

행위는 HTTP 요청 메서드를 통해 표현하며 URI에 표현하지 않는다.

# bad
GET /todos/delete/1

# good
DELETE /todos/1