JavaScript REST API

< REST >

> REST API는 REST를 기반으로 서비스 API를 구현한 것을 의미한다.

REST(Representational State Transfer)는 HTTP를 기반으로 클라이언트가 서버의 리소스에 접근하는 방식을 규정한 아키텍처이다.

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

RESTful은 REST를 정의하는 비공식적 가이드라고 한다. 반드시 지켜야 하는 것은 아니지만 여러 의견들을 모아 효율적으로 정의하기 위해 만들었다고 한다.

 

> REST API의 구성

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

구성 요소	내용	표현 방법
자원	자원	HTTP URI(엔드 포인트)
행위	자원에 대한 행위	HTTP Method
표현	자원에 대한 행위의 구체적 내용	HTTP message Pay Load

 

> REST API 설계 원칙

1. URI는 정보의 자원을 표현해야 한다.
   • 리소스명은 동사보다는 명사를 사용한다.
   • URI는 자원을 표현하는 데 중점을 두어야 한다.
   • get 같은 행위에 대한 표현이 들어가서는 안 된다.
2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)으로 표현한다.

1의 예

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

// good
GET /todos/1

2의 예

// bad
GET /todos/delete/1

// good
DELETE /todos/1

 

 

 

 

 

< HTTP Method >

주로 5가지의 Method(GET, POST, PUT, PATCH, DELETE)를 사용하여 CRUD를 구현한다.

Method	Action	역할	페이로드
GET	index/retrieve	모든/특정 리소스를 조회	X
POST	create	리소스를 생성	O
PUT	replace	리소스 전체를 교체	O
PATCH	modify	리소스 일부를 수정	O
DELETE	delete	모든/특정 리소스를 삭제	X