모던 자바스크립트 Deep Dive - REST API

 

44장 REST API

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

REST API의 구성

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

 

REST API 설계 원칙

가장 중요한 기본적인 원칙

• 1 ) URI는 리소스를 표현하는데 집중
• 2 ) 행위에 대한 정의는 HTTP 요청 메서드를 통해 하는 것.

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

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

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

# good
GET /todos/1

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

• HTTP 요청 메서드는 클라가 서버에게 요청의 종류와 목적(리소스에 대한 행위)을 알리는 방법.
• 주로 5가지 요청 메서드를 사용하여 CRUD를 구현함.

• 리소스에 대한 행위는 HTTP 요청 메서드를 통해 표현하며 URI에 표현하지 않음.

# bad
GET /todos/delete/1

# good
DELETE /todos/1

1 ) GET 요청

• todos 리소스에서 모든 todo를 취득함.

2 ) POST 요청

• todos 리소스에 새로운 todo를 생성함.
• ~~Header 메서드를 사용하여 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정해야함.
• ~~Header(’content-type’, ‘application/json’)

3 ) PUT 요청

• 특정 리소스 전체를 교체할 때 사용함.
• ~~Header 메서드를 사용하여 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정해야함.
• ~~Header(’content-type’, ‘application/json’)

4 ) PATCH 요청

• 특정 리소스의 일부를 수정할 때 사용함.
• ~~Header 메서드를 사용하여 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정해야함.
• ~~Header(’content-type’, ‘application/json’)

5 ) DELETE 요청

• todos 리소스에서 id를 사용하여 todo를 삭제함.