RESTful API 개념

[REST API 디자인 가이드]

https://covenant.tistory.com/241

REST란? REST API 디자인 가이드

 

Naver D2 강연 : https://www.youtube.com/watch?v=RP_f5dMoHFc

 

REST

분산 하이퍼미디어 시스템(ex : 웹)을 위한 아키텍쳐 스타일

아키텍쳐 스타일 : 제약조건의 집합

 

REST 아키텍쳐 스타일

1. Uniform (유니폼 인터페이스)

유니폼 인터페이스는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍쳐 스타일을 말한다.

 

2. Stateless(무상태성)

작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만 단순히 처리한다. 그렇기 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로서 구현이 단순해진다.

 

3. Cacheable(캐시 가능)

REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에 사용하는 기존 인프라를 그대로 활용 가능하다. 따라서 HTTP가 가진 캐싱 기능을 적용하려면 HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 된다.

 

4. Client - Server 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간의 의존성이 줄어들게 된다.

 

5. layered interface(계층형 구조)

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 Proxy, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

 

[Uniform Interface의 제약조건]

1.identification of resources

2. manipulation of resources through representations

3. Self-descriptiveness(자체 표현 구조)

REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다. 즉, 메시지는 스스로를 설명해야 한다.

 

4. hypermedia as the engins of application state (HATEOAS)

애플리케이션의 상태는 hyperlink를 이용해 전이되어야 한다.

 

 

현재, 우리가 말하는 REST API에서 REST 스타일의 uniform interface 제약조건 중 3,4번은 지켜지지 못하고 있다.

왜 uniform interface가 필요한가?

독립적 진화

• 서버와 클라이언트가 각각 독립적으로 진화한다.
• 서버의 기능이 변경되어도 클라이언트를 업데이트할 필요가 없다.

 

REST 만들게 된 계기 : how do I improve HTTP without breaking the web.

 

---

 

REST가 웹의 독립적 진화에 도움을 주었나?

• HTTP에 지속적으로 영향을 줌
• Host 헤더 추가
• 길이 제한을 다루는 방법이 명시
• URI에서 리소스의 정의가 추상적으로 변경됨 “식별하고자 하는 무언가”
• 기타 HTTP와 URI에 많은 영향을 줌
• HTTP/1.1 명세 최신판에서 REST에 대한 언급이 들어

 

그런데 REST API는?

• REST API는 REST 아키텍쳐 스타일을 따라야 한다.
• 오늘날 스스로 REST API라고 하는 API들의 대부분이 REST 아키텍쳐 스타일을 따르지 않는다.

 

REST API도 저 제약조건을 다 지켜야 하는가?

REST API 란 하이퍼텍스트를 포함한 self-descriptive한 메시지의 uniform interface를 통해 리소스에 접근하는 API

by Roy T. Fielding

 

 

우리는 꼭 REST한 API 개발을 해야하는가?

시스템 전체를 통제할 수 있다고 생각하거나, 진화에 관심이 없다면 REST에 대해 따지느라 시간을 낭비하지 마라.

 

 

self-descriptive, HATEOAS가 독립적인 진화에 어떻게 도움이 될까?

self-descriptive 확장 가능한 커뮤니케이션

→ 서버나 클라이언트가 변경되더라도 오고가는 메시지는 언제나 self-descriptive 하므로 언제나 해석이 가능하다.

 

 

HATEOAS 애플리케이션 상태 전이의 late binding

→ 어디서 어디로 전이가 가능한지 미리 결정되지 않는다. 어떤 상태로 전이가 완료되고 나서야 그 다음 전이될 수 있는 상태가 결정된다. 쉽게 말해서, 링크는 동적으로 변경될 수 있다.

 

 

 

REST하게 만들어 보자. ⇒ self-descriptive와 HATEOAS 만족 시키기

 

[self-descriptive]

방법 1. Media type

 

방법 2. profile

 

 

 

[HATEOAS]

HTTP 헤더나 본문에 링크를 담아 만족시킬 수 있다.

 

hyperlink는 반드시 uri여야 하는가? NO

media type 등록은 필수인가? NO

media type을 IANA에 등록하기 → 쉽다, 이름 충돌을 피할 수 있다.

 

 

 

 

http api vs rest api에 대한 김영한 님의 말 :

https://www.inflearn.com/questions/126743/http-api-vs-rest-api

HTTP API vs REST API - 인프런 | 질문 & 답변