REST API
REST는 HTTP를 기반으로 클라이언트가 서버의 리소스에 접근하는 방식을 규정한 아키텍처고, REST API는 REST를 기반으로 서비스 API를 구현한 것을 의미한다.
1. REST API의 구성
-
REST API는 자원, 행위, 표현의 3가지 요소로 구성된다.
-
REST는 자체 표현 구조로 구성되어 REST API만으로 HTTP 요청의 내용을 이해할 수 있다.
구성요소 | 내용 | 표현 방법 |
---|---|---|
자원 | 자원 | URI(엔드 포인트) |
행위 | 자원에 대한 행위 | HTTP 요청 메서드 |
표현 | 자원에 대한 행위의 구체적 내용 | 페이로드 |
2. REST API 설계 원칙
REST에서 가장 중요한 기본적인 원칙은 두 가지다.
- URI 는 리소스를 표현하는 데 집중하고 행위에 대한 정의는 HTTP 요청 메서드를 통해 하는 것이 RESTful API를 설계하는 중심 규칙이다.
1️⃣ URI는 리소스를 표현해야한다.
- 리소스를 식별할 수 있는 이름은 동사보다는 명사를 사용한다.
#bad
GET/getTodos/1
GET/todos/show/1
#good
GET/todos/1
2️⃣ 리소스에 대한 행위는 HTTP 요청 메서드로 표현한다.
-
HTTP요청 메서드는 클라이언트가 서버에 요청의 종류와 목적(리소스에 대한 행위)을 알리는 방법이다.
-
주로 5가지 요청 메서드를 사용하여 CRUD를 구현한다.
HTTP 요청 메서드 | 종류 | 목적 | 페이로드(전송되는 데이터) |
---|---|---|---|
GET | index/retrieve | 모든/특정 리소스 취득 | X |
POST | create | 리소스 생성 | O |
PUT | replace | 리소스 전체 교체 | O |
PATCH | modify | 리소스 일부 수정 | O |
DELETE | delete | 모든/특정 리소스 삭제 | X |
- 리소스에 대한 행위는 HTTP 요청 메서드를 통해 표현하며 URI에 표현하지 않는다.
#bad
GET/getTodos/delete/1
#good
DELETE/todos/1
댓글남기기