REST

REST

REST(Representational State Transfer) 의 약자로, resource의 이름을 구분하여 해당 resource의 상태를 보내주고 받는 네트워크상에서 Client와 Server 사이의 통신 방식 중 하나입니다. 여기서 resource는 해당 소프트웨어(혹은 프로그램)이 관리하는 모든 DB(문서, 이미지, 데이터, 프로그램)를 의미합니다. 예를들어 Starbucks에서는 DB내에 음료 정보가 resource면 이를 표현하기 위해서 drinks로 표현을 정해서 사용합니다. 정보 전달은 데이터가 요청되어지는 시점에서 HTTP URI(Uniform Resource Identifier)를 통해서 resource의 상태를 전달합니다. 이 때에는 JSON이나 XML를 통해서 데이터를 주고 받는 것이 일반적입니다, 또한 HTTP Method와 같은 HTTP프로토콜을 그대로 활용을 하기 때문에 WEB의 장점을 최대한 활용이 가능한 Architecture Style입니다.

CRUD Operation + HTTP Method : Create(POST, resource 생성) / Read(GET, resource의 정보 조회) / Update(PUT, resource의 정보 업데이트) / Delete(DELETE, resource 삭제)

REST의 구성요소

• Resource(자원), URI: 모든 자원은 고유한 ID를 가지고 ID는 서버 DB내에 존재하고 Client는 각 자원의 상태를 조작하기 위해 request를 보냅니다. HTTP에서는 이러한 자원을 구별하는 ID는 Drinks/1같은 HTTP URI입니다.

• Verb(행위), Method: Client는 URI를 이용해서 자원을 지원하고 자원을 조작하기 위해 Method를 사용합니다. HTTP 프로토콜에서는 CRUD를 씁니다.

• Representation(표현): Client가 Server로 request를 보냈을 때 Server가 response로 보내주는 자원의 상태를 Representation이라고 합니다. REST에서는 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 표현으로 나타낼 수 있습니다.

REST의 특징

• Client-Server 구조: 자원이 있는 Server, 자원을 요청하는 Client의 구조를 가집니다.
  - REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임집니다.
  - Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임집니다.

• Stateless: HTTP는 Stateless 프로토콜 이므로 REST 역시 무상태성을 가진다. 클라이언트의 Context를 서버에 저장하지 않습니다. 그러므로 Session과 Cookie같은 context정보를 신경쓰지 않아도 되므로 구현이 단순해집니다.

• Cachealble: 웹 표준 HTTP 프로토콜을 그대로 사용하므로, 웹에서 사용하는 기존의 인프라를 그대로 활용 가능합니다.

• Layered System(계층화): API 서버는 순수 비즈니스 로직을 수행하고 그 앞단에 사용자 인증, 암호화, 로드밸런싱 등을 하는 계층을 추가하여 구조상의 유연성을 줄 수 있습니다.

• Uniform Interface(인터페이스의 일관성): URI로 지정한 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. HTTP 표준에만 따른다면 특정 언어나 기술에 종속되지 않은채로 모든 플랫폼에 사용이 가능합니다.

• 자체 표현 구조: 동사(Method) + 명사(URI)로 이루어져있으며 어떤 메소드에 무슨 행위를 하는지 알 수 있으며 REST API 자체가 매우 쉬워서 API 메세지 자체만 보고도 API를 이해할 수 있습니다.

REST의 장점

REST는 다양한 장점들을 가지고 있습니다. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없습니다. 또한 HTTP 표준 프로토콜에 따르는 멀티 플랫폼에서 지원이 가능하기에 다양한 브라우저와 안드로이드폰, 아이폰와 같은 모바일 디바이스에서도 통신이 가능합니다. 사용자의 입장에서는 REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있습니다.

REST API

REST API는 REST를 기반으로해서 API를 구현하는 것을 뜻합니다.

API

• API(Application Programming Interface)란 클라이언트가 리소스를 요청할 수 있도록 서버측에서 제공된 인터페이스(interface)를 말합니다.
• API로 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 합니다.

REST API의 규칙

REST API를 표현하기 위해서는 몇가지 규칙을 지켜줘야 한다.
REST API의 원형 종류
REST API에 URI를 디자인할 때 쓰는 모든 Resource들을 지칭한 언어입니다. 도큐먼트, 컬렉션, 스토어, 컨트롤러로 구성되어 있습니다.

1) 도큐먼트 (단수): DB의 row단위 컬렉션에서 하나의 객체단위로 하는 단일 정보
ex) 1, 2, 3, team1, team2, 등

2) 컬렉션 (복수): 도큐먼트들의 집합, 관리 주체는 서버. 어떤 리소스가 도큐먼트의 집합이며, 관리 주체가 서버인 것
ex) projects --> 프로젝트들의 관리 주체는 서버

3) 스토어 (복수): 도큐먼트들의 집합 / 관리 주체는 클라이언트
ex) favorites --> 좋아하는 것들의 관리 주체는 클라이언트
장바구니 --> 장바구니는 클라이언트가 관리 주체

4) 컨트롤러 (복수): 컬렉션, 스토어의 메서드 기능. C.R.U.D라는 표준적인 메서드와 논리적으로 매핑되지 않는 application의 고유한 행동을 의미합니다. 보통 URI 경로의 마지막에 표시합니다.
ex) isExist / register

1. URL는 정보를 자원을 표현해야 합니다.

• resource는 동사보다는 명사를, 대문자 보다는 소문자를 사용합니다.
• resource의 도큐먼트 이름으로는 단수 명사를 사용해야 합니다.
• resource의 컬렉션 이름으로는 복수 명사를 사용해야 합니다.
• resource의 스토어 이름으로는 복수 명사를 사용해야 합니다.
  Ex) GET /Member/1 → GET /members/1

2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현합니다.

• URL에 HTTP Method가 들어가면 안됩니다.
  Ex) GET /members/delete/1 → DELETE /members/1
• URL에 행위에 대한 동사 표현이 들어가면 안됩니다. (즉, CRUD 기능을 나타내는 것은 URL에 사용하지 않습니다.)
  Ex) GET /members/show/1 → GET /members/1
Ex) GET /members/insert/2 → POST /members/2
• 경로 부분 중 변화하는 부분은 유일한 값으로 대체합니다. (즉, :id는 하나의 특정 resource를 나타내는 고유값입니다.)
  Ex) student를 생성하는 route : POST /students
Ex) id=12인 student를 삭제하는 route : DELETE /students/12

GET http://api.test.com/categories/blouses/shirts/319
블라우스 중 셔츠 319번 목록을 조회
categories : 콜렉션
blouses : 콜렉션
shirts : 콜렉션
319 : 도큐먼트

REST API 설계 규칙

1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용합니다.
   Ex) http://restapi.com/drinks/teas

2. URL 마지막 문자로 슬래시(/ )를 포함하지 않습니다.

• URL에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며, URL가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URL도 달라져야 합니다.
• REST API는 분명한 URL를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URL 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

3. 하이픈(-)은 URL 가독성을 높이는데 사용합니다.

• 불가피하게 긴 URL경로를 사용하게 된다면 하이픈을 사용해 가독성을 높여줍니다.

4. 밑줄(_)은 URL에 사용하지 않습니다.

• 밑줄은 보기 어렵거나 하이퍼링크의 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않습니다.

5. URL 경로에는 소문자가 적합합니다.

• URL 경로에 대문자 사용은 피하도록 합니다.

6. 파일확장자는 URL에 포함하지 않습니다.

• REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URL안에 포함시키지 않습니다.

7. 리소스 간에는 연관 관계가 있는경우, /리소스명/리소스 ID/관계가 있는 다른 리소스명을 사용해서 구분합니다.
   Ex) GET : /users/{userid}/devices

RESTful

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어입니다.
그러므로 ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있습니다. 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 RESTful API의 목표로 볼수 있습니다. RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 목표입니다.