본문 바로가기

이것저것 스터디📚/JavaScript - Deep Dive

DeepDive - 44장. REST API

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


44.1 REST API의 구성

- REST API는 자원, 행위, 표현의 3가지 요소로 구성된다.

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

44.2 REST API 설계 원칙

- 1. URI는 리소스를 표현하는데 집중한다.

- 2. 행위에 대한 정의는 HTTP 요청 메서드를 통해한다.

 

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

- URI는 리소스를 표현하는데 중점을 두어야 한다.

- 리소스를 식별할 수 있는 이름은 동사보다는 명사를 사용한다.

- 이름에 get 같은 행위에 대한 표현이 들어가서는 안된다.

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

# good
GET /todos/1

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

- HTTP 요청 메서드는 클라이언트가 서버에게 요청의 종류와 목적(리소스에 대한 행위)을 알리는 방법이다.

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

이웅모 님의〔 모던 자바스크립트 Deep Dive 〕책을 공부하며 정리했습니다.