REST API 또는 RESTful API 라고도 불리는 API는 이름 그대로 REST를 기반으로 만들어진 API를 의미한다.
REST API를 다루기 전에 REST에 대해서 먼저 알아보자 🏃♂️
REST 란?
REST란 (Representational State Transfer) 의 약자로,
어떤 자원에 대해 CRUD 연산을 수행하기 위해 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 것을 의미한다.
- HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시
- HTTP Method(POST, GET, PUT, DELETE)를 이용해
- 자원(URI)에 대한 CRUD 연산을 적용하는 것을 의미한다
⚡ CRUD
Create : 데이터 생성 (POST)
Read : 데이터 조회 (GET)
Update : 데이터 수정 (PUT)
Delete : 데이터 삭제 (DELETE)
REST의 구성 요소
- 자원 (Resource) - URI
- 행위 (Verb) - HTTP Method (GET, POST, PUT, PATCH, DELETE)
- 표현 (Representations) 클라이언트와 서버가 데이터를 주고받는 형태의 표현 (ex. json)
REST의 특징
1. 일관된 인터페이스 (Uniform Interface)
일관된 인터페이스란 자원(URI)에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미한다. 이것은 Client의 플랫폼 (Android, IOS, Jsp..)에 무관하고 특정 언어나 기술에 종속받지 않기 때문에 REST API는 HTTP를 사용하는 모든 플랫폼에서 요청이 가능하다.
2. 무상태성 (Stateless)
서버는 각각의 요청을 별개의 것으로 인식하고 처리해야하고, 이전 요청이 다음 요청에 영향을 주거나 연관되어 있으면 안된다. 따라서 REST API는 세션정보나 쿠키정보를 활용하여 작업을 위한 상태정보를 저장 및 관리하지 않는다. 이렇게 되면 API 서버는 들어오는 요청만 단순하게 처리하면 된다. 이러한 무상태성 때문에 서비스의 자유도가 높으며, 서버에 불필요한 정보를 관리하지 않으므로 구현이 단순하다. 또한 서버의 처리방식에 일관성을 부여하고 서버의 부담을 줄여준다.
3. 캐시 가능 (Cacheable)
REST의 가장 큰 특징중 하나는 HTTP라는 기존의 웹 표준을 그대로 사용한다는 점이기 때문에, 캐싱 기능을 적용할 수 있는데, HTTP 프로토콜 표준에서 사용하는 Last-Modified Tag 또는 E-Tag를 이용하여 캐싱을 구현 할 수 있고 이를 통해 대량의 요청을 효율적으로 처리할 수 있도록 도와준다.
4. 서버-클라이언트 구조 (Server-Client Architecture)
서버는 API를 제공하고 클라이언트는 사용자 인증, Context(세션, 로그인 정보)등을 직접 관리하는 등 역할을 서로 확실하게 구분시켜 서버와 클라이언트에서 개발해야 할 내용이 명확해지고 서로 간의 의존성을 줄인다.
5. 자체 표현 (Selft-Descriptivness)
REST의 가장 큰 특징중 하나는 REST API 메세지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다는 것이다.
6. 계층형 구조 (Layered System)
REST 서버는 다층 계층으로 구성될 수 있으며, 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.
(하지만 클라이언트는 서버와 직접 통신을 하고 있는 것인지, 중간 매체와 통신하고 있는 것인지 알 수 없다.)
REST의 장단점
장점
- HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
- HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
- HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용이 가능하다.
- REST API 메시지가 의도하는 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
- 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
- 서버와 클라이언트의 역할을 명확하게 분리한다.
단점
- HTTP Method 형태가 제한적이다.
- 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
- 구형 브라우저에서 호환이 되지않아 지원해주지 못하는 동작이 많다.
REST API란? (+RESTful API)
REST API란 결국 위에서 언급했던 REST의 원리를 따르는 API를 의미한다.
하지만 REST API 라고 하여 모두 RESTful API라고 할 수 없으며 REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful API라고 할 수 있다!
REST API의 URI 설계규칙
- 동사보다는 명사를 사용, 대문자보다는 소문자를 사용한다.
- 공백, 언더바(_) 대신 하이픈(-) 사용한다.
- 슬래시(/)로 계층 관계를 표현한다.
- 마지막에 슬래시(/)를 사용하지 않는다.
- 파일 확장자를 URI에 사용하지 않는다.
- CRUD를 URI에 사용하지 않는다.
