RESTful API

RESTful API

월드 와이드 웹(WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식으로 자원을 정의하고 자원에 대한 주소를 지정하는 방법 전반에 대한 패턴

• REST란 REpresentational State Transfer의 약자, ful은 형용사형 어미
• REST가 디자인 패턴이다, 아키텍쳐다 많은 이야기가 존재하는데, 하나의 아키텍쳐로 볼 수 있다.
• REST는 Resource Oriented Architecture이다. API 설계의 중심에 자원(Resource)이 있고, HTTP Method를 통해 자원을 처리하도록 설계하는 것

REST 6가지 원칙

• Uniform Interface(유니폼 인터페이스)
  • URL로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍쳐 스타일
• Stateless(무상태성)
  • 작업을 위한 상태정보를 따로 저장하고 관리하지 않음
  • 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됨
  • 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해짐
• Caching(캐시 가능)
  • REST는 HTTP라는 기준 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용 가능 => HTTP가 가진 캐싱 기능이 적용 가능
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능
• Self-descriptiveness(자체 표현 구조)
  • REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있음
• Client-Server 구조
  • REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됨
• Hierarchical system(계층형 구조)
  • REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.
• Code on demand

RESTful 하게 API를 디자인 한다는 것을 무엇을 의미하는가

1. 리소스와 행위를 명시적이고 직관적으로 분리
   • 리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야 한다.
   • 행위는 HTTP Method로 표현되고, GET(조회), POST(생성), PUT(기존 entity 전체 수정), PATCH(기존 entity 일부 수정), DELETE(삭제)을 분명한 목적으로 사용한다.
2. Message는 Header와 Body를 명확하게 분리해서 사용
   • Entity에 대한 내용은 Body에 담는다.
   • 애플리케이션 서버가 행동할 판단의 근거가 되는 컨트롤 정보인 API 버전 정보, 응답받고자 하는 MIME 타입 등은 header에 담는다.
   • header와 body는 http header와 http body로 나눌 수도 있고, http body에 들어가는 json 구조로 분리할 수도 있다.
3. API 버전을 관리
   • 환경은 항상 변하기 때문에 API의 signature가 변경될 수도 있음에 유의
   • 특정 API를 변경할 때는 반드시 하윟환성을 보장해야 함
4. 서버와 클라이언트가 같은 방식을 사용해서 요청하도록 함
   • 브라우저는 form-data 형식의 submit 으로 보내고 서버에서는 json 형태로 보내는 식의 분리보다는 json으로 보내든, 둘 다 form-data 형식으로 보내든 하나로 통일
   • 다른 말로 표현하자면 URI가 플랫폼 중립적이어야 한다.

어떠한 장점이 존재하는가?

1. Open API를 제공하기 쉽다.
2. 멀티플랫폼 지원 및 연동이 용이하다.
3. 원하는 타입으로 데이터를 주고 받을 수 있다.
4. 기존 웹 인프라(HTTP)를 그대로 사용할 수 있다.

단점은 뭐가 있을까?

1. 사용할 수 있는 메소드가 4가지 밖에 없다.
2. 분산환경에는 부적합하다.
3. HTTP 통신 모델에 대해서만 지원한다.

Reference

• REST API 제대로 알고 사용하기