44장 REST API
- REST : HTTP를 기반으로 클라이언트가 서버의 리소스에 접근하는 방식을 규정한 아키텍처
- REST API : REST를 기반으로 서비스 API를 구현한 것
- RESTful : REST의 기본 원칙을 성싱히 지킨 서비스 디자인
1. REST API의 구성
| 구성 요소 | 내용 | 표현 방법 |
|---|
| 자원 | 자원 | URI(엔드포인트) |
| 행위 | 자원에 대한 행위 | HTTP 요청 메서드 |
| 표현 | 자원에 대한 행위의 구체적 내용 | 페이로드(전송의 근본적인 목적이 되는 데이터) |
2. REST API 설계 원칙
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 |
# bad
GET /todos/delete/1
#good
DELETE /todos/1