[Spring] REST란?

REST란?

REST(Representational State Transfer)의 개념

• 자원을 ‘이름’으로 구분하여 해당 자원의 ‘상태(정보)’를 주고 받는 모든 것!
• 즉 자원(Resource)의 표현(Representation)에 의한 상태 전달을 말한다.
• 구체적으로 HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
• 한마디로 URI와 HTTP 메소드를 이용해 객체화된 서비스에 접근하는 것!

즉 REST란 

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

REST CRUD Operation

• Create: 생성(POST)
• Read: 조회(GET)
• Update: 수정(PUT)
• delete: 삭제(DELETE)

REST의 장점

• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능하다.
• RestAPI 메시지가 의도하는 바를 명학하게 나타낼 수 있다.
• 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화 한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.

REST의 단점

• 표준이 존재하지 않는다.
• 사용할 수 있는 메소드가 제한적이다.
• 구형 브라우저저가 아직 제대로 지원하지 못한다.(PUT, DELETE, pushStats)

REST가 필요한 이유는?

• 애플리케이션 분리 및 통합
• 다양한 클라이언트의 등장
• 멀티 플랫폼에 대한 지원

REST 구성 요소

REST는 다음과 같은 3가지로 구성이 되어있다. 

1. 자원(Resource) : HTTP URI모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
   자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
   Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
2. 자원에 대한 행위(Verb) : HTTP Method HTTP 프로토콜의 Method를 사용한다.
   HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.
3. 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load
   Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
   REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
   JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
   
   

REST의 특징

1. Server-Client(서버-클라이언트 구조)
   - 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
   - REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
   - Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   서로 간 의존성이 줄어든다.
2. Stateless(무상태)
   HTTP 프로토콜은 Stateless Protocol이므로 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(계층화)
   Client는 REST API Server만 호출한다.
   REST Server는 다중 계층으로 구성될 수 있다.
   API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
   또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
   PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다
5. Code-On-Demand(optional)
   Server로부터 스크립트를 받아서 Client에서 실행한다.
   반드시 충족할 필요는 없다.
6. Uniform Interface(인터페이스 일관성)
   URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
   HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
   특정 언어나 기술에 종속되지 않는다.

REST API란?

REST API의 개념

• API(Application Programming Interface)란?
  • 데이터와 기능의 집합을 제공하여 서로 정보를 교환 가능 하도록 하는 것
• REST 기반으로 서비스 API를 구현한 것을 REST API라고 한다.
• 최근 OpenAPI, 마이크로 서비스 등을 제공하는 업체 대부분은 REST API를 제공한다.

REST API 설계 예시

1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

Bad Example http://khj93.com/Running/
Good Example  http://khj93.com/run/  

 

2. 마지막에 슬래시 (/)를 포함하지 않는다.

Bad Example http://khj93.com/test/  
Good Example  http://khj93.com/test

 

3. 언더바 대신 하이폰을 사용한다.

Bad Example http://khj93.com/test_blog
Good Example  http://khj93.com/test-blog  

 

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

Bad Example http://khj93.com/photo.jpg  
Good Example  http://khj93.com/photo  

 

5. 행위를 포함하지 않는다.

Bad Example http://khj93.com/delete-post/1  
Good Example  http://khj93.com/post/1  

• URI는 정보의 자원을 표현
  • resource는 동사보다는 명사, 대문자보다는 소문자
  • resource의 도큐먼트 이름으로는 단수 명사를 사용
  • resource의 컬렉션 이름으로는 복수 명사를 사용
  • reousrce의 스토어 이름으로는 복수 명사를 사용
    • ex) GET /Member/1 (x) → GET /members/1 (o)
• 자원에 대한 행위는 HTTP Method로 표현(GET, POST, PUT, DELETE)
  • URI에 HTTP Method 사용 X
    • ex) GET /members/show/1 (x) → GET /members/1 (o)
  • URI에 행위에 대한 동사표현 X
• 경로 부분 중 변하는 부분은 유일한 값으로 대체
  • id는 하나의 특정 resource를 나타내는 고유 값

RESTful이란?

RESTFUL이란 REST의 원리를 따르는 시스템을 의미합니다. 하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아닙니다.  REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며

모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있습니다.

• RESTful은 REST의 비공식적 구현 가이드이다.
• ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 목적이다.
• CRUD 기능을 모두 POST로만 처리한다던가, route에 resource, id 외의 정보가 들어가는 경우는 RESTful 하지 못한 경우라고 볼 수 있다.

 

참고 레퍼런스

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