REST? REST API? 5분만에 이해하기

REST API란 무엇일까요? 그 전에 먼저 REST에 대해 알아보겠습니다.

REST?

REST(Representational State Transfer)는 월드 와이드 웹과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식이다. - 위키피디아

좀 더 설명하면 REST는 HTTP기반으로 필요한 자원에 접근하는 방식을 정해놓은 아키텍쳐입니다. 그렇다면 여기서 말하는 자원은 무엇일까요? 자원은 저장된 데이터(DBMS)는 물론, 이미지/동영상/문서(pdf 등)와 같은 파일, 서비스(이메일 전송, 푸쉬 메시지 등)를 모두 포함합니다. 그리고 REST API는 REST를 통해 서비스 API를 구현한 것을 말합니다.

REST 인터페이스에는 4개의 가이드가 존재하는데요,

자원의 식별
2. 서버에 있는 개별 리소스는 모두 구별되어야 합니다.
2. 각 리소스에 대해 클라이언트는 직접 접근하지 않고, 대신 URI와 같은 데이터베이스 레코드를 이용합니다.
메시지를 통한 리소스의 조작
1. 모든 요청은 클라이언트가 요청할 때마다 필요한 정보를 주기 때문에 서버에서는 세션 정보를 보관할 필요가 없습니다.
2. 그렇기 때문에 서비스에 자유도가 높아지고 유연한 아키텍쳐 적응이 가능합니다.
자기서술적 메시지
1. 메시지를 이해하기 위해 메시지 내용을 알아야 한다면 자기서술적 메시지가 아닙니다.
2. 모든 리소스는 HTTP 메소드 GET, POST, PUT, DELETE 4개의 메소드로 접근되어야한다는 것입니다.
애플리케이션의 상태에 대한 엔진으로서 하이퍼미디어
1. 서비스 내에 하나의 리소스가 주변에 연관 된 리소스들과 연결되어 표현이 되어야 한다는 점입니다.
2. 하이퍼링크처럼 콘텍스트 속에서 URI가 제공되는 경우가 그 예시입니다.

REST의 구성요소

REST는 리소스, 메소드, 메시지의 세 가지로 구성되어 있습니다.

리소스

REST에서는 자원에 접근 할 때 URI(Uniform 리소스 Identifier)로 하게 됩니다. URI는 자원의 위치를 나타내는 일종의 식별자인데, URI설계시 지켜야하는 설계규칙에 대해 살펴보겠습니다.

0. ‘/’의 쓰임새

먼저 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용됩니다. 아래 예시에서

https://www.zoo/animals/dogs/john

해당하는 사이트에서 이름이 john인 개의 정보를 찾을 때, zoo - animals - dogs - john까지 도달하는 구조임을 알 수 있습니다. 그렇기 때문에 URI 마지막 문자로 슬래시(/)를 포함하지 않습니다.

1. URI를 이루는 리소스들은 동사보다는 명사로 이루어져야 합니다.

자원의 정보를 표현해야 하는 URI는 동사보다는 명사로 구성되어야 합니다. REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같이 표현합니다.

ex) 일반적으로 소유 ‘has’의 관계를 표현할 때
/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET /users/{userid}/devices

만약 관계명이 복잡하다면, 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를 들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용될 수 있습니다.

ex ) (관계명이 애매하거나 구체적 표현이 필요할 때
GET /users/{userid}/likes/devices

2. URI에서는 ‘_’(언더스코어)보다는 ‘-’(하이픈)을 권장합니다.

_은 리소스 해석에 혼란을 줄 수 있기 때문입니다.

3. URI 경로에는 소문자가 적합합니다.

URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하고 있습니다.

4. 파일 확장자는 URI에 포함시키지 않는다.

https://restapi.example.com/members/soccer/345/photo.jpg (X)
https://restapi.example.com/members/soccer/345/photo (O)

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않습니다. Accept header를 사용하도록 해야합니다.

GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

HTTP 메소드

자원에 접근할 때, HTTP 메소드를 통해 어떤 성격의 요청인지 서버에 전달합니다. 그 종류로는 GET, POST, PUT, DELETE가 존재합니다.

restapi-01-1

Endpoint

메소드는 같은 URI들에 대해서도 다른 요청을 하게끔 구별해주는 항목이 있습니다. 이것을 Endpoint라고 하는데요. 위의 표에서 https://api.domain.com/books/1 URI에 대해 GET, PUT, DELETE 메소드에 따라 다른 요청 성격을 띄고 있는 것을 알 수 있습니다.

메시지

메시지는 HTTP header와 body, 응답상태코드로 구성되어 있습니다. header와 body에 포함된 메시지는 메시지를 처리하기 위한 충분한 정보를 포함하는 자기서술적 메시지여야 합니다.

HTTP 바디에 어떤 포맷으로 데이터가 담겼는지 정의합니다. 요청 HTTP 헤더는 ‘Accept’ 항목으로 응답 HTTP 헤더는 ‘Content-type’으로 컨텐츠 타입을 설명합니다.

Body

자원에 대한 정보를 전달(데이터 포맷: JSON/ XML/ 사용자 정의 포맷)

응답상태 코드

restapi-02-1

응답상태 코드를 통해 리소스 요청에 대한 응답을 할 수 있습니다.

REST의 장/단점

장점

언어와 플랫폼에 독립적이다.
SOAP보다 개발이 쉽고 단순하다.
REST가 지원하는 프레임워크나 언어 등의 도구들이 없어도 구현이 가능하다.
HTTP를 그대로 사용하기 때문에 기존 웹 인프라를 사용 가능하다.

단점

HTTP 프로토콜만 사용이 가능하다.
p2p 통신 모델을 가정했기 때문에 둘 이상을 대상으로 하는 분산환경엔 유용하지 않다.
보안, 정책등에 대한 표준이 없기 때문에 관리가 어렵고 이러한 부분까지 고려해서 구현 할 경우 설계나 구현에서 좀 더 어려움을 갖는다.

REST API의 활용

API를 설명 할 때 웹서비스와 특정 기술을 연결해주는 징검다리 역할이라고 말을 했었는데요, REST API도 똑같습니다. 예를 들면 카카오 developer에 있는 카카오 로그인 프로그램을 자신의 웹서비스에 구현하고자 한다면 카카오에서 제공하는 로그인 API를 사용하면 됩니다. 이때 방법으로써 REST가 쓰이는 것이 REST API가 되는 것이죠.

웹서비스에서 로그인 데이터에 필요한 부분들을 REST 방식(URI형식으로 request)으로 카카오 데이터 베이스에 요청하는 식으로 작동하는 것이죠. 정말 간단하게 구현이 가능해서 REST API는 웹에서 일반적으로 사용되는 API라고 볼 수 있습니다.