[REST API] REST란

REST(REpresentational State Transfer)

• 소프트웨어 아키텍처 형식
• 분산 하이퍼미디어 시스템을 위한 아키텍처 스타일인 동시에 아키텍처 스타일의 모음
• 로이필딩(Roy Fielding)의 2000년 박사학위 논문에서 소개
• 네트워크 아키텍처 원리의 모음
• 인터넷 상 시스템 간의 상호 운용성(interoperability)을 제공
• REST API : REST 아키텍처 스타일을 따르는 API

아키텍처 스타일 - 제약조건들의 집합

네트워크 아키텍처 - 자원을 정의하고 자원에 대한 주소를 지정하는 전반적인 방법

네트워크 아키텍처에서 말하는 자원은 DB, 이미지/동영상/문서와 같은 파일, 서비스(이메일, 푸쉬 메시지 등)을 포함한다

---

REST 아키텍처

• Client-Server
• Stateless
• Cache
• Uniform Interface
• Layered System
• Code-On-Demand (Optional)

Code-On-Demand는 서버에서 코드를 클라이언트에 보내 실행할 수 있어야 한다는 개념으로 대표적인 예로 자바스크립트가 있다

---

REST의 구체적인 개념

• HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용할 수 있다

• CRUD Operation

  • Create : 생성(POST)
  • Read : 조회(GET)
  • Update : 수정(PUT)
  • Delete : 삭제(DELETE)

• REST의 장점

  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다
  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다
  • 서버와 클라이언트의 역할을 명확하게 분리

• REST의 구성요소

  • 자원(Resource) : URI
    • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다
    • 자원을 구별하는 ID는 HTTP URI다. (ex. /todo/:todo_id)
    • Client는 URI를 통해 자원을 지정하고 해당 자원의 상태(정보)를 Server에 요청한다
  • 행위(Verb) : HTTP Method
    • HTTP 프로토콜의 Method를 사용한다
    • HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다
  • 표현(Representation)
    • Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 적절한 응답을 보낸다.
    • REST에서 하나의 자원은 JSON, XML, TEXT 등 여러 행태의 Representation으로 나타내어 질 수 있다
    • JSON 혹은 XML을 통해 데이터를 주고 받는다

---

REST의 아키텍처

REST 아키텍처 스타일 중 Uniform Interface를 제외한 다른 스타일은 HTTP만 따라도 만족하는 스타일인데, 오늘날 대부분 REST API라 불리는 REST API들은 이 Uniform Interface를 만족하지 않는 경우가 많음

• Client–Server
  • REST 서버는 API 제공, 클라이언트는 비즈니즈 로직 처리등을 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어든다
• Stateless
  • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
  • Client의 context를 Server에 저장하지 않는다. 즉, 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않는다
  • Server는 들어오는 요청만을 단순히 처리하면 되기 때문에 서비스의 자유도가 높아지며 부담이 줄어든다
  • Q - 인증을 위해 쿠키를 심고 세션에서 필요한 정보를 가져오는 경우, 이는 stateless인가?
    A - Session 정보를 활용한다면 stateless가 아니다
  • REST에서는 각각의 요청에 서버가 필요한 정보가 모두 담겨야 한다
• Cacheable
  • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다
  • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다
• Layered System
  • Client는 REST API Server만 호출한다.
  • Server는 다중 계층으로 구성될 수 있다. (API Server는 순수 비즈니스 로직 처리, 앞 단에서 보안, 로드밸런싱, 암호화등을 추가하여 유연한 구성이 가능)
• Uniform Interface
  • 서버와 클라이언트가 각각 독립적으로 진화해야한다
  • 서버의 기능이 변경되어도 클라이언트를 업데이트할 필요가 없다

---

Uniform Interface 아키텍처 스타일(4가지 제약조건)

• identification of resources
  • REST에서 정보는 Resource고, resource는 반드시 유일한 URI로 식별할 수 있어야 한다
  • 웹 기반 REST에서는 resource 접근에 URL 사용
  • ex - http://domain/resource/1
• manipulation of resources through representations
  • Resources와 Presentations은 구분한다
  • Resource의 생성/변경/삭제 표현을 HTTP 헤더에 담아 전송을 해서 달성하는 방법
  • Resource의 표현계층(representation)을 Resource의 식별자(URL)로부터 분리한 것
• self-descriptive messages
  • 요청이나 응답 메시지에는 이를 이해하기 위한 모든 정보가 포함되어야 한다
  • 메시지 스스로 메시지에 대한 설명이 가능해야한다
  • 서버가 변해서 메시지가 변해도 클라이언트는 그 메시지를 보고 해석이 가능해야한다
  • 방법 1. content-type를 IANA에 등록하고 Content-Type으로 사용
  • 방법 2. 메세지에 대한 정보를 담은 명세 링크를 profile 링크 헤더에 추가
• hypermedia as the engine of application state(HATEOAS)
  • 애플리케이션의 상태는 Hyperlink를 이용해 전이되어야 한다
  • 상태 전이가 가능한지는 미리 결정되지 않는다. → 링크는 동적으로 변경될 수 있다

---

Self-descriptive messages(예시)

HTTP/1.1 200 OK
Content-Type: application/json-patch+json
Link: <https://example.org/docs/todos>; rel="profile"

[
    {"id" : 1, "title" : "회사 가기"},
    {"id" : 2, "title" : "집에 가기"},
]

→ Json-patch의 명세를 보면 확인할 수 있음

→ 클라이언트는 Content-Type으로 리소스 데이터의 의미(대괄호가 무슨 역할인지 등) 을 알 수 있다

→ 메시지를 보는 사람은 명세를 찾아갈 수 있으므로 문서의 의미를 온전히 해석가능 (id가 무슨 데이터인지 등)

---

HATEOAS(예시)

아래는 실제 github의 REST API이다.

해당 REST API는 응답 메시지에 다음 애플리케이션 상태로 전이할 수 있는 링크가 있기 때문에 HATEOAS를 만족한다고 할 수 있다.

---

정리

• 오늘날 대부분의 REST API는 사실 REST를 따르지 않고 있다
• REST의 제약조건 중에는 특히 Self-descriptive와 HATEOAS를 잘 만족하지 못한다
• REST는 긴 시간에 걸쳐 진화하는 웹 애플리케이션을 위한 것이다
  • Self-descriptive는 custom media type이나 profile link relation등으로 만족시킬 수 있다
  • HATEOAS는 HTTP 헤더나 본문에 링크를 담아 만족시킬 수 있다

---

용어정리

Representation

• 어떤 "리소스"의 상태를 담은 정보

State

• 웹 애플리케이션의 상태

Transfer

• 상태의 전송을 의미

→ 링크를 클릭함으로써 브라우저가 보여주던 페이지는 A에서 B로 바뀐다. 즉, 웹 애플리케이션의 상태가 변경된 것이다. 또한 이상태의 변경은 representation의 전송(Transfer)을 통해 이루어 졌다고 한다.

MIME 타입

• 클라이언트에게 전송된 문서의 다양성을 알려주기 위한 메커니즘
• text/plain, application/json 등등

---

Reference

http://haah.kr/2017/05/24/rest-the-dissertation-summary/

https://blog.npcode.com/2017/04/03/rest의-representation이란-무엇인가/

https://www.youtube.com/watch?v=RP_f5dMoHFc