REST, REST API란 뭘까?
1. REST란?
REST(Representational State Transfer)는 인터넷과 같이 복잡한 네트워크 통신의 등장에 따라 이를 관리하기 위한 지침으로 만들어진 것으로, 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 모든 것을 의미한다.
HTTP URI을 통해 자원을 명시하고, HTTP Method를 통해 URI에 대한 CRUD Operation을 적용한다.
※ CRUD Operation이란?
대부분의 컴퓨터 소프트웨어가 갖는 기본적인 데이터 처리 기능 Create, Read, Update, Delete를 묶어서 일컫는 말로 REST에서의 CRUD Operation 동작 예시는 다음과 같다.
Create : 데이터 생성(POST)
Read : 데이터 조회(GET)
Update : 데이터 수정(PUT, PATCH)
Delete : 데이터 삭제(DELETE)
REST의 구성 요소
- 자원(Resource) - HTTP URI
- 행위(Verb) - HTTP Method(GET, POST, PUT, DELETE)
- 표현(Representations) - HTTP Message Pay Load(JSON, XML, TEXT, RSS, ...)
REST의 특징
1. Server - Client(서버 - 클라이언트 구조)
서버는 API 제공, 클라이언트는 사용자 인증이나 세션, 로그인정보 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 서버, 클라이언트에서 개발해야 할 내용이 명확하고 상호 의존성이 줄어든다.
2. Stateless(무상태)
작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기에 API 서버는 들어오는 요청만을 단순히 처리한다. 서비스의 자유도가 높아지고 서버에 불필요한 정보를 저장하고 관리하지 않으므로 구현이 단순해진다.
3. Cacheable(캐시 처리 가능)
HTTP 기존 웹표준을 사용하기 때문에 웹에서 사용하는 기존 인프라를 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용해 캐싱 구현이 가능하다.
4. Layered System(계층화)
다중 계층으로 구성될 수 있으며 보안, 로드 벨런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있다.
5. Uniform Interface(인터페이스 일관성)
URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일이다.
6. Self-descriptiveness(자체 표현 구조)
REST API 메시지만 보고도 이게 무엇인지 쉽게 이해할 수 있는 자체 표현 구조로 이루어져 있다.
REST의 장단점
1. 장점
- HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
- HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
- REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
- 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
- 서버와 클라이언트의 역할을 명확하게 분리한다.
2. 단점
- 표준이 자체가 존재하지 않아 정의가 필요하다.
- HTTP Method 형태가 제한적이다.
- 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
- 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)
2. REST API란?
REST(Representational State Transfer API)란, REST의 원리를 따르는 API라는 뜻으로 openAPI, Micro Service 등을 제공하는 업체 대부분은 REST API를 제공하고 있다. 그리고 이 REST API를 설계하기 위해 지켜야 할 규칙이 존재하며, 메뉴얼도 함께 제공되어야 한다.
1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.
Bad Example https://small-stepping.tistory.com/Running/
Good Example https://small-stepping.tistory.com/run/
2. 마지막에 슬래시 (/)를 포함하지 않는다.
Bad Example https://small-stepping.tistory.com/test/
Good Example https://small-stepping.tistory.com/test
3. 언더바 대신 하이폰을 사용한다.
Bad Example https://small-stepping.tistory.com/test_blog
Good Example https://small-stepping.tistory.com/test-blog
4. 파일확장자는 URI에 포함하지 않는다.
Bad Example https://small-stepping.tistory.com/photo.jpg
Good Example https://small-stepping.tistory.com/photo
5. 행위를 포함하지 않는다.
Bad Example https://small-stepping.tistory.com/delete-post/1
Good Example https://small-stepping.tistory.com/post/1
3. RESTful이란?
RESTful하다는 것은 REST 원리를 따르는 시스템을 RESTful하다고 한다. 즉, REST API를 제공하는 웹 서비스를 RESTful이라고 할 수 있다. RESTful은 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 목적으로, 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주요한 목적이라고 할 수 있다.
예를 들어, URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템이게 되고, 이는 REST API를 사용하였음에도 RESTful하지 못한 시스템이라고 할 수 있는 것이다. (CRUD 기능을 모두 POST로만 처리하는 API라든지, route에 리소스, ID 외의 정보, URI의 Method에 대한 부분이 들어간다던지...)