[Network] RESTful API

REST

• 월드와이드웹(WWW)과 같은 분산 하이퍼 미디어 시스템을 위한 SW 아키텍처의 한 형식으로 자원을 정의하고 자원에 대한 주소를 지정하는 방법 전반에 대한 패턴
• REpresentational State Transfer
• ful이 붙어서 "~한 API"라는 의미로 많이 쓰인다.
• 즉, REST의 기본 원칙을 성실히 지킨 서비스 디자인은 RESTful하다라고 표현한다.
• REST는 하나의 아키텍처라고 볼 수 있다.(디자인 패턴 느낌은 아니다)
• 즉, Resource Oriented Architecture이다.
• API 설계의 중심에 자원(Resource)이 있고 HTTP Method를 통해 자원을 처리하도록 설계하는 것.
  Ref - https://ko.wikipedia.org/wiki/REST

REST의 6가지 원칙

• Uniform Interface
• Stateless
• Caching
• Client-Server
• Hierachical System
• Code on demand

RESTful하게 API를 디자인하다.

1. 리소스와 행위를 명시적이고 직관적으로 분리한다.
   • 리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야한다.
   • 행위는 HTTP Method로 표현하고, GET(조회), POST(생성), PUT(기존 entity 전체 수정), PATCH(기존 entity 일부 수정), DELETE(삭제)을 분명한 목적으로 사용한다.

2. Message는 Header와 Body를 명확하게 분리해서 사용한다.
   • Entity에 대한 내용은 body에 담는다.
   • Application Server가 행동할 판단의 근거가 되는 컨트롤 정보인 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가 플랫폼 중립적이어야 한다.

장점

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

단점

• 사용 가능한 메소드가 4가지 뿐이다
• 분산 환경에선 부적합하다
• HTTP 통신 모델에 대해서만 지원이 가능하다.

Reference

https://spoqa.github.io/2012/02/27/rest-introduction.html