REST API
- REST : Representational State Transfer
- API : Application Programming Interface
REST는 HTTP를 기반으로 클라이언트가 서버의 리소스에 접근하는 방식을 규정한 아키텍처이다. REST의 기본 원칙을 성실하게 지킨 서비스 디자인을 "RESTful"로 표현한다. REST API는 REST를 기반으로 서비스 API를 구현한 것을 의미한다.
REST API 구성 요소
REST API는 자원, 행위, 표현 3가지 요소로 구성된다. REST는 자체 표현 구조로 구성되어 REST API만으로 HTTP 요청의 내용을 이해할 수 있다.
- 자원(resource, 자원) - URI(엔드포인트)
- 행위(verb, 자원에 대한 행위) - HTTP 요청 메서드
- 표현(representations, 자원에 대한 행위의 구체적인 내용) - 페이로드(사용에 있어 전송되는 데이터)
REST API 설계 원칙
RESTful API를 설계하는 기본적인 중심 규칙 두 가지는 다음과 같다.
1. URI는 리소스를 표현하는데 집중해야 한다.
URI는 리소슬 ㄹ표현하는데 중점을 두어야 한다. 리소스를 식별할 수 있는 이름은 명사를 사용한다. (get 등 행위에 대한 표현 x)
# bad
GET /getInfo/1
GET /info/show/1
# good
GET /info/12. 리소스에 대한 행위는 HTTP 요청 메서드로 표현한다.
HTTP 요청 메서드는 클라이언트가 서버에게 요청의 종류와 목적을 알리는 방법이다. 주로 5가지 요청 메서드(GET, POST, PUT, PATCH, DELETE)를 사용하여 CRUD를 구현한다.
GET 모든/특정 리소스 취득
POST 리소스 생성
PUT 리소스의 전체 교체
PATCH 리소스의 일부 수정
DELETE 모든/특정 리소스 삭제
리소스에 대한 행위는 HTTP 요청 메서드를 통해 표현하며, URI에 표현하지 않는다. 리소스를 취득하는 경우에는 GET, 삭제하는 경우에는 DELETE를 사용하는 등 리소스에 대한 행위를 명확히 표현한다.
#bad
GET /info/delete/1
#good
DELETE /info/1
Junior Front-End Developer