aotoyae

[SW]REST API : URI & HTTP 요청 메서드 GET, POST.. 본문

Software

[SW]REST API : URI & HTTP 요청 메서드 GET, POST..

aotoyae 2024. 2. 19. 12:24

 

💡 REST : HTTP 를 기반으로 클라이언트가 서버의 리소스에 접근하는 방식을 규정한 아키텍처
💡 REST API : REST 를 기반으로 서비스 API 를 구현한 것
💡 HTTP 요청 메서드 : 클라이언트가 서버에게 요청의 종류와 목적(리소스에 대한 행위)을 알리는 방법

 

🧑🏻‍💻 REST 의 기본 원칙을 성실히 지킨 서비스 디자인을 "RESTful " 하다고 표현한다!

 

가장 중요한 기본적인 두 원칙을 알아보자.

 

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

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

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

# good
GET /todos/1

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

 

2. 행위에 대한 정의는 HTTP 요청 메소드를 통해 함

주로 5가지 요청 메서드를 사용해 CRUD 를 구현한다.

리소스를 가져오는 경우에는 GET, 삭제하는 경우에는 DELETE 를 사용해 리소스에 대한 행위를 명확히 나타낸다.

HTTP 요청 메서드 종류 목적 페이로드
GET index/retrieve 모든/특정 리소스 취득
POST create 리소스 생성 ⭕️
PUT replace 리소스의 전체 교체 ⭕️
PATCH modify 리소스의 일부 수정 ⭕️
DELETE delete 모든/특정 리소스 삭제

 

# good
DELETE /todos/1

# bad
GET /todos/delete/1