old-radio@home:~$

Archive

About

RSS

REST

자주쓰는 REST를 한번 정리할 필요가 있어서 아래 내용을 정리한다.

REST는 뭐지?

REST는 REpresentational State Transfer의 약어로, 클라이언트와 서버 간에 데이터를 주고받는데 필요한 소프트웨어 아키텍처 스타일 중 하나이다.

특히 분산 시스템 설계를 위한 아키텍처 스타일이다.

아키텍처 스타일이란건 쉽게 말하면 제약조건의 집합이라고 보면 된다.

RESTful은 뭐지?

RESTful은 위의 제약 조건의 집합(아키텍처 스타일과 원칙)을 모두 만족하는 것을 의미한다.

RESTful API라는 말은 REST 아키텍처 원칙을 모두 만족하는 API라는 뜻이다.

REST 는 아키텍처 스타일이고, RESTful은 그것을 만족하는것을 의미하니까 엄밀히 말하면 REST와 RESTful은 다른 의미인 것이다.

REST가 필요한 이유?

  1. 분산 시스템

    규모가 큰 어플리케이션을 모듈과 기능별로 분리하기 쉽다. 즉 MSA(Micro Service Architecture)에 적합.

    그리고 RESTful API를 사용하면 어떤 다른 모듈 또는 어플리케이션이라도 상호간에 통신을 할 수 있다.

  2. 멀티플랫폼

    RESTful API를 사용하면서 데이터만 주고 받기 때문에 여러 클라이언트가 자유롭고 부담없이 데이터를 이용할 수 있다.

    다양한 클라이언트의 등장하면서 Backend 하나로 다양한 Device를 대응이 가능하다.

    서버는 요청한 데이터만 보내주면 되고 클라이언트에서도 해당 데이터를 적절하게 보여주기만 하면 된다.

REST 구성요소?

  1. 자원(Resource) , URI

    모든 자원은 고유한 ID를 가지고 ID는 서버에 존재하고 클라이언트는 각 자원의 상태를 조작하기 위해 요청을 보낸다. HTTP에서 이러한 자원을 구별하는 ID는 ‘Students/1’ 같은 HTTP URI 이다.

  2. 행위(Verb) , Method

    클라이언트는 URI를 이용해 자원을 지정하고 자원을 조작하기 위해 Method를 사용한다. HTTP 프로토콜에서는 GET , POST , PUT , DELETE 같은 Method를 제공한다.

  3. 표현(Representation)

    클라이언트가 서버로 요청을 보냈을 때 서버가 응답으로 보내주는 자원의 상태를 Representation이라고 한다. REST에서 하나의 자원은 JSON , XML , TEXT , RSS 등 여러형태의 Representation으로 나타낼수 있다.

REST 특징?

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

자원이 있는 Server , 자원을 요청하는 Client의 구조를 가진다. REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보 등)을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.

  1. 무상태 (Stateless)

HTTP는 Stateless 프로토콜 이므로 REST 역시 무상태성을 가진다. API를 제공해주는 서버는 세션(session)을 그 서버 쪽에 유지하지 않는다는 의미. 즉, HttpSession과 같은 컨텍스트 저장소에 상태정보를 따로 저장하고 관리하지 않고, API 서버는 들어오는 요청만을 단순 처리하면 된다. 세션과 같은 컨텍스트 정보를 신경쓸 필요가 없어 구현이 단순해진다.

  1. 캐시 처리 가능 (Cachealble)

웹 표준 HTTP 프로토콜을 그대로 사용하므로 , 웹에서 사용하는 기존의 인프라를 그대로 활용 가능하다. HTTP가 가진 가장 강력한 특징 중의 하나인 캐싱 기능을 적용할 수 있다. 일반적인 서비스에서 조회 기능이 주로 사용됨을 감안하면, HTTP 리소스들을 웹 캐쉬 서버 등에 캐싱하는 것은 용량이나 성능 면에서 이점이 있다. 캐싱 구현은 HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 가능하다.

  1. 계층화 (Latered System)

API 서버는 순수 비즈니스 로직을 수행하고 그 앞단에 사용자 인증 , 암호화 , 로드밸런싱 등을 하는 계층을 추가하여 구조상의 유연성을 줄 수 있다. 클라이언트는 서버에 직접 연결되었는지 미들웨어에 연결되었는지 알 필요가 없어야 한다.

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

URI로 지정한 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. HTTP 표준에만 따른다면 모든 플랫폼에 사용이 가능하다. 자원에 대해 통일된 방식을 통해 처리하기 때문에 HTTP표준만 준수하면 안드로이드,IOS,JAVA등 다양안 OS와 언어에 종속받지 않고 모든 환경에서 사용이 가능하다.(Loose Coupling) 자원은 유일하게 식별 가능해야한다.

  • 메시지는 스스로를 설명(self-descriptive)해야한다.
  • 하이퍼링크를 통해서 어플리케이션의 상태(HATEOAS)가 전이 되어야 한다. 하이퍼링크에 따라 다른 페이지를 보여줘야하며, 데이터마다 어떤 URL에서 왔는지 명시해줘야 한다.
  1. 자체 표현 구조

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

REST 장단점?

장점

  1. 쉬운 사용

HTTP 프로토콜 인프라를 그대로 사용하므로 별도의 인프라를 구축할 필요가 없다.

  1. 클라이언트-서버 역할의 명확한 분리

클라이언트는 REST API를 통해 서버와 정보를 주고받는다. REST의 특징인 Stateless에 따라 서버는 클라이언트의 Context를 유지할 필요가 없다.

  1. 특정 데이터 표현을 사용가능

REST API는 헤더 부분에 URI 처리 메소드를 명시하고 필요한 실제 데이터를 ‘body’에 표현할 수 있도록 분리시켰다. JSON , XML 등 원하는 Representation 언어로 사용 가능하다.

단점

  1. 메소드의 한계

REST는 HTTP 메소드를 이용하여 URI를 표현한다. 이러한 표현은 쉬운 사용이 가능하다는 장점이 있지만 반대로 메소드 형태가 제한적인 단점이 있다.

  1. 표준이 없음

REST는 설계 가이드 일 뿐이지 표준이 아니다. 명확한 표준이 없다.

RESTful API 설계

  1. URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)

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

URI 설계시 주의할 점

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

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

  3. 하이픈(-)은 URI 가독성을 높이는데 사용

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

  5. URI 경로에는 소문자가 적합하다.

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

참고사이트

https://spring.io/understanding/REST

https://www.youtube.com/watch?v=RP_f5dMoHFc

https://bcho.tistory.com/953

https://meetup.toast.com/posts/92