Web - REST, REST API, RESTful

REST (Representational State Transfer)

REST는 Representational State Transfer의 약자로써, 한국어로 직역하면 대표적인 상태 전달이라는 뜻이다. 이는 월드 와이드 웹 (WWW) 과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식으로써, 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한으로 활용할 수 있는 아키텍처 스타일이다. REST는 기본적으로 네트워크 상에서의 Client 와 Server 사이의 통신 방식 중 하나이며, 이를 차용하는 회사 또는 서비스가 많기 때문에 꼭 알아두어야 할 개념이다.

 

가장 간단하게 이야기하면, 자원의 표현에 따라서 상태를 전달한다는 뜻이다. 이 또한 어려울 수 있는데, 

 

자원의 표현 (출처: https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html)

위와 같이 자원 (resource) 의 표현 (representation) 에 의한 상태 전달을 한다는 것이다. 여기서 자원이란 해당 소프트웨어가 관리하는 모든 것을 의미하며, 문서, 그림, 데이터 등이 될 수 있고, 자원의 표현이란 그 자원을 표현하기 위한 이름을 뜻한다. 예를 들어 어떤 영화들이 현재 상영되고 있는지를 가져오고 싶을 때, "movies" 라는 자원의 표현으로 이를 가져오려고 한다는 것이다.

 

이러한 자원의 표현으로 클라이언트가 원하는 상태 즉 정보를 전달한다. 여기서 상태는 데이터가 요청되어지는 시점에서의 자원의 상태 (정보) 이며, JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적이다.

 

개념

HTTP URI (Uniform Resource Identifier) 를 통해 자원을 명시하고, HTTP Method (POST, GET, PUT, DELETE 등) 를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

 

즉, REST는 자원 기반의 구조 (ROA, Resource Oriented Architecture) 로써, 설계의 중심에 Resource가 있고, 이를 처리하기 위하여 HTTP Method를 통해서 처리하도록 설계된 아키텍쳐를 의미하는 것이다. 이를 실현시키기 위해서 웹사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

 

기본적으로 CRUD Operation은 다음 HTTP Method들로 진행된다.

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

 

REST의 장단점

장점:

1. HTTP 프로토콜의 인프라를 그대로 사용하며, REST API의 사용을 위한 별도의 인프라를 구축할 필요가 없다.
2. HTTP 프로토콜의 표준을 최대한 활용함으로써 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
3. HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용 가능하다.
4. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
5. REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
6. 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
7. 서버와 클라이언트의 역할을 명확하게 분리한다.

단점:

1. 표준이 존재하지 않는다.
2. 사용할 수 있는 메소드가 4가지 (POST, GET, PUT, DELETE) 밖에 없다.
3. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 더 어렵게 느껴진다.
4. 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다. 예) PUT, DELETE를 사용하지 못하는점, pushState를 지원하지 않는 점.

REST 구성 요소

1. 자원 (Resource) : URI

모든 자원에는 고유한 ID가 존재하며, 이 자원은 Server에 존재한다. 자원을 구별하는 ID는 "/groups/:group_id"와 같은 HTTP URI이다. 여기서 Client는 URI를 이용해서 자원을 지정하고, 해당 자원의 상태 (정보) 에 대한 조작을 Server에 요청한다.

 

2. 행위 (Verb) : HTTP Method

HTTP 프로토콜의 Method를 사용하며, GET, POST, PUT, DELETE와 같은 메서드를 사용한다.

 

3. 표현 (Representation of Resource)

Client가 자원의 상태 (정보) 에 대한 조작을 요청하면 Server는 이에 적절한 응답 (Representation) 을 보낸다. REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.

 

REST의 특징

1. Server-Client (서버-클라이언트 구조)

자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client로써, REST Server는 API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다. Client는 사용자 인증, context (세션, 로그인 정보) 등을 직접 관리하고 책임진다. 이러한 구조로 인해 서로 간 의존성이 줄어든다.

 

2. Stateless (무상태)

HTTP 프로토콜의 특징 중 하나는 Stateless 하다는 것이므로 REST 역시 무상태성을 갖는다. 이로 인해 Client의 context를 Server에 저장하지 않는다. 즉 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다는 장점이 있다. 또한, Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다. 즉 각 API 서버가 Client의 요청만을 단순 처리하며, 이전 요청이 다음 요청의 처리에 연관이 돼있으면 안된다. 물론 이전 요청이 DB를 수정하여 DB와 서버에 의해 바뀌는 것은 허용된다. 이로써 Server의 처리 방식에 일관성을 부여하고, 부담이 줄어들며, 서비스의 자유도가 높아진다.

 

3. Cacheable (캐시 처리 가능) 

웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다. 즉, HTTP가 가장 가장 강력한 특징 중 하나인 캐싱 기능을 활용할 수 있다는 것이다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하여 캐싱 구현이 가능하다.

대량의 요청을 효율적으로 캐시를 사용하여 처리할 수 있으며, 이로써 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

 

4. Layered System (계층화)

클라이언트는 REST API Server만 호출하게 된다. 여기서 REST Server는 다중 계층으로 구성될 수 있다. 예를 들어 API Server는 순수 비즈니스 로직을 수행하고, 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다. 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다. 또한, PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

 

5. Uniform Interface (인터페이스 일관성)

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. 이는 HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용이 가능하다. 즉 특정 언어나 기술에 종속되지 않는다.

 

REST API란

REST API란 REST를 기반으로 서비스 API를 구현한 것이다. 최근 OpenAPI, 마이크로 서비스 등을 제공하는 업체 대부분이 REST API를 제공한다.

 

REST API는 서비스 제공자 입장에서도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높임으로써 유지보수 및 운용을 편리하게 할 수 있게 된다. 또한 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트 및 서버를 구현할 수 있으며, 이로써 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다는 장점이 생긴다.

 

REST API 설계 기본 규칙

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소

 

1. URI는 정보의 자원을 표현해야 한다.

- resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.

- resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다. 예) GET /movies/1

- resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다. 예) GET /movies

- resource의 스토어 이름으로는 복수 명사를 사용해야 한다. 예) GET /members/1

 

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

- URI에 HTTP Method가 들어가면 안된다.

예) GET /members/delete/1 -> DELETE /members/1

- URI의 행위에 대한 동사 표현이 들어가면 안된다.

예) GET /members/show/1 -> GET /members/1

- 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.

예) student를 생성하는 route: POST /students

예) id = 12인 student를 삭제하는 route: DELETE /students/12

 

기타 설계 규칙

1. 슬래시 구분자 ( / ) 는 계층 관계를 나타내는 데 사용한다.

예) http://example.com/houses/apartments 

 

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

- URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.

- REST API는 분명한 URI를 만들어 통신을 해야하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에 슬래시를 사용하지 않는다.

 

3.  불가피하게 긴 URI 경로를 사용하게 된다면 하이픈 ( - ) 을 사용하여 가독성을 높인다.

 

4. 밑줄 ( _ ) 은 사용하지 않는다.

 

5. URI 경로로는 소문자를 사용한다.

- 대문자 사용을 피한다.

 

6. 파일확장자는 URI에 포함하지 않는다.

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

- 대신, Accept Header를 사용한다.

예) GET /members/soccer/345/photo HTTP/1.1 Host: example.com Accept: image/jpeg

 

RESTful이란

RESTful이란 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다. 즉 REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있다. 이의 목적은 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이며, RESTful한 API를 구현하는 근본적 목적은 성능 향상이 아닌 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이다. 따라서 성능이 중요한 상황에서 굳이 RESTful한 API를 구현할 필요는 없다.

 

출처

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

https://github.com/WeareSoft/tech-interview/blob/master/contents/network.md#frame-packet-segment-datagram