[CS Study] Network - REST and RESTful

Frye 'de Bacon·2023년 11월 10일

Computer Science(CS)

목록 보기

12/40

REST(REpresentational State Transfer)

REST의 정의

REST는 "REpresemtational State Transfer"의 약자로 자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 것을 의미한다. 즉, 자원(resource)의 표현(representation)에 의한 상태 전달이라고 할 수 있다. 이를 조금 더 자세히 구분하면 다음과 같다.

자원(Resource) : 해당 소프트웨어가 관리하는 모든 것(문서, 이미지, 응용 프로그램 등)
표현(Representation) : 해당 자원을 표현하기 위한 이름(예를 들어 DB의 판매 물품 정보가 자원이라면 'product'를 자원의 표현으로 정할 수 있다)
상태 전달 : 데이터가 요청되는 시점에 자원의 상태를 전달함(일반적으로 JSON 혹은 XML 등을 사용)

REST는 기본적으로 웹의 기존 기술과 HTTP를 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일이며, 네트워크상에서 클라이언트와 서버 사이의 통신 방식 중 하나이다.

REST의 개념

REST는 어떤 자원에 대해 CRUD 연산을 수행할 때 URI(Resource)로 GET, POST 등의 방법(Method)을 사용하여 요청을 보내며, 요청을 위한 자원은 특정한 형태(Representation of resource)로 표현된다.

URL은 Uniform Resource Locator로 인터넷상 자원의 위치를 의미하고, URI는 Uniform Resource Identifier로 인터넷상의 자원을 식별하기 위한 문자열 구성을 말한다. URI는 URL을 포함하는 더 큰 범위의 개념으로 이해할 수 있다.

REST의 구성 요소

자원(Resource) - URI

REST는 서버에 존재하는 모든 자원에 고유한 ID인 HTTP URI(예 : /exgroups/:exgroup_id)를 부여한다.
클라이언트는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 서버에 요청한다.

행위(Verb) - Method

HTTP의 Method를 사용한다.

HTTP는 GET, POST, PUT, DELETE라는 네 가지 method를 제공한다.

구분	내용
GET	READ : URI가 가진 정보를 검색하기 위한 요청
POST	CREAT : 클라이언트에서 서버로 정보를 전달하기 위한 요청
PUT	UPDATE : 정보의 내용을 갱신하기 위한 요청
DELETE	DELETE : 정보의 삭제(안전성 문제로 대부분의 서버에서는 비활성화함)

표현(Representation of resource)

클라이언트와 서버가 데이터를 주고받는 형태로, JSON, XML, TEXT, RSS 등이 있다.
일반적으로 JSON과 XML을 가장 많이 사용한다.

REST의 특징

Server-Client 구조

REST 서버는 API를 제공하고 비즈니스 로직의 처리와 저장 등을 책임진다.
클라이언트는 사용자 인증이나 context(세션, 로그인 정보 등)을 직접 관리하고 책임진다.
서버와 클라이언트의 역할을 확실히 구분하여 상호 의존성을 줄이는 구조이다.

Stateless(무상태)

HTTP를 활용하므로 마찬가지로 무상태성을 갖는다.
클라이언트의 context를 서버에 저장하지 않으므로 구현이 단순해진다.
서버는 각각의 요청을 별개의 것으로 인식하고 처리하며, 이는 서버의 처리 방법에 일관성을 부여하여 서비스의 자유도를 높여 준다.

Cacheable(캐시 처리 가능)

HTTP의 가장 강력한 특징 중 하나인 캐싱 기능을 사용할 수 있다.
HTTP 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용해 캐싱을 구현할 수 있다.
캐시 사용을 통해 응답시간이 빨라지고 서버의 트랜잭션을 방지하여 전체 응답 시간, 성능, 서버의 자원 이용률 등을 향상시킬 수 있다.

Layered system(계층화)

클라이언트는 REST API 서버만 호출한다.
REST 서버는 다중 계층으로 구성할 수 있으며, 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가할 수도, Proxy나 Gateway 등의 중간 매체를 사용하는 것도 가능하다.
클라이언트는 서버와 직접 통신하는지 중간 서버를 거치는지를 알 수 없다.

Uniform interface(인터페이스 일관성)

URI로 지정한 resource에 대한 요청을 통일되고 한정적으로 수행하는 아키텍처 스타일이다.
HTTP 표준에 따르는 모든 플랫폼에서 사용이 가능하며, 따라서 특정 언어나 기술에 종속되지 않는다.

REST API

REST API의 개념

REST API란 REST의 특징을 기반으로 서비스 API를 구현한 것을 말한다. 최근에는 OpenAPI(구글 맵과 같이 누구나 사용할 수 있도록 공개된 API)나 마이크로 서비스(하나의 어플리케이션을 여러 개의 작은 어플리케이션으로 쪼개어 변경 및 조합이 가능하도록 만든 아키텍처) 등을 제공하는 기업 대부분은 REST API를 제공하고 있다.
REST API의 가장 큰 특징은 각 요청이 어떤 동작 혹은 어떤 정보를 위한 것인지 그 요청 자체로 추론할 수 있다는 것이다(Self-Descriptiveness).

REST API의 기본 설계 규칙

REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있다.

URI는 정보의 자원을 표현해야 한다.

resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
resource의 도큐멘트 이름으로는 단수 명사를 사용해야 한다.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

자원에 대한 행위는 HTTP method로 표현한다

URI에 TTP method가 들어가선 안 된다.
URI의 행위에 대한 동사 표현이 들어가면 안 된다.
경로 부분 중 변경이 가능한 부분은 유일값으로 대체한다.

REST API의 설계 규칙

슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.
http://restapi.example.com/houses/apartments
URI 마지막 문자로 슬래시를 포함하지 않는다
URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 뜻이다. 그리고 역으로 리소스가 다를 경우 URI도 당연히 달라져야 한다.
REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않아야 한다.
http://restapi.example.com/houses/apartments/ → X
하이픈(-)은 URI 가독성을 높이는 데 사용한다.
불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
밑줄(_)은 사용하지 않는다.

밑줄은 보기 어렵기도 하고, 경우에 따라 밑줄 때문에 문자가 가려지기도 한다. 따라서 가독성을 위해 밑줄은 사용하지 않는다.

URI 경로에는 소문자를 사용한다.
URI 경로에 대문자를 사용하는 것은 피하도록 한다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.
파일 확장자는 URI에 포함하지 않는다.

REST API 설계 예시

CRUD	HTTP Method	Route
resource의 목록을 표시	GET	/resource
resource 중 하나의 내용을 표시	GET	/resource/:id
resource를 생성	POST	/resource
resource를 수정	PUT	/resource/:id
resource를 삭제	DELETE	/resource/:id

RESTful

RESTful이란?

RESTful은 일반적으로 REST 아키텍처를 구현하는 웹 서비스를 나타내는 용어로, 공식적인 용어는 아니나 보통 'REST API'를 제공하는 웹 서비스를 'RESTful'하다고 표현한다.

RESTful의 목적

RESTful은 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이다. 예를 들어 RESTful한 API는 요청을 보내는 주소만으로도 어떤 것을 요청하는지 확인이 가능할 것이다('https://market.com/products'는 상품의 목록을 받는 요청일 것이다).
즉 RESTful API의 구현은 성능 향상이 아니라 API의 이해도 및 호환성의 제고에 있으므로, 성능이 중요한 상황에서는 꼭 RESTful한 API를 구현하지 않아도 된다.