김춘삼씨의 고양이 2024. 9. 25. 09:00

📌 REST API

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

 

📌 REST API의 구성

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

 

📌 REST API 설계 원칙

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

  • 리소스를 식별할 수 있는 이름은 동사보다는 명사를 사용함
  • 이름에 get 같은 행위에 대한 표현이 들어가서는 안됨
# bad
GET /getTodos/1
GET /todos/show/1

# good
GET /todos/1

 

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

  • HTTP 요청 메서드: 클라이언트가 서버에게 요청의 종류와 목적(리소스에 대한 행위)을 알리는 방법
  • 리소스에 대한 행위는 HTTP 요청 메서드를 통해 표현하며 URI에 표현하지 않음
HTTP 요청 메서드 종류 목적 페이로드
GET index/retrieve 모든/특정 리소스 취득 X
POST create 리소스 생성 O
PUT replace 리소스의 전체 교체 O
PATCH modify 리소스의 일부 수정 O
DELETE delete 모든/특정 리소스 삭제 X
# bad
GET /todos/delete/1

# good
DELETE /todos/1

 

 

 

참고문헌 및 출처 : 모던 자바스크립트 Deep Dive (이웅모)