Computer Science/네트워크

[CS] REST란? RESTful이란?

findTheValue 2021. 7. 28. 17:33
REST ?

  • 발단 : HTTP1.0과 HTTP1.1의 개념을 소통하기 위해.
  • 동기 : 웹이 어떻게 동작해야 하는지에 대한 구조적 모델을 만들어 웹 프로토콜 표준을 위한 guiding framework 역할을 하기 위함.'
    • HTTP뿐만 아니라 TCP/IP 프로토콜 스택을 사용하는 어플리케이션 프로토콜이 많은데 수많은 웹 App과 protocol의 사양과 인터페이스의 일관성을 위해 웹 표준이 필요하다 생각.

 

 

 

  • REST는 분산 하이퍼미디어 시스템(웹)의 구조화 스타일을 다룬다.
    • HTTP를 사용하는 웹은 최초 문서 공유의 목적에서 크게 벗어나 하이퍼 미디어 시스템이 되었다. REST는 이런 시스템을 구조화 할때 지켜야 할 스타일을 정의. 웹 App또한 분산 하이퍼미디어 시스템이기 때문에 적용가능.
    • 표준을 위해 여러 제약(contraint)를 만들었다.
      • 클라이언트-서버
        • 클라이언트와 서버를 분리하고 인터페이스로만 소통할 수 있게 해서 유저는 멀티플랫폼의 이동이 가능해지고 서버의 컴포넌트 를 단순화해 확장성을 향상. 각 컴포넌트들은 독립적으로 진화할 수 있다.
        • 가령 클라이언트 환경은 단순히 브라우저의 문제뿐 아니라 모바일, 데스크탑, 랩탑 등의 다양한 환경으로 발산했는데 서버와 클라이언트단은 분리되어 서버는 이런 클라이언트의 문제를 고려할 필요가 없어졌다.
      • Stateless(무상태성)
        • HTTP는 원래 무상태 프로토콜. 상태가 필요하면 상태정보를(가령 세션) 서버에 두지 말고 클라이언트에 의존할 것. 이 제약은 가시성, 책임성, 확장성의 효과를 불러온다. 가시성은 시스템이 요청에 대해 그 요청 메시지 이상 고민할 필요가 없어서이고, 책임성은 부분 시스템 실패로부터 회복하는 작업을 쉽게 해주며, 확장성은 서버가 요청간 상태정보를 저장할 필요가 없어 자원을 쉽게 해제할 수 있어서이다.
        • 무상태는 단점도 있다. 상태를 저장하지 않기 때문에 요청마다에 데이터를 반복적으로 보내야 할 수도 있어 성능의 문제가 있을 수 있다. 또 상태를 클라이언트에 두면 어플리케이션이 여러 클라이언트 환경에 종속적이 되기 때문에 서버가 어플리케이션에 대한 완전한 제어를 할 수 없다.
      • Cache
        • 네트워크 성능을 향상시키는 대표적인 방법이 cache이고 웹은 클라이언트부터 시작해서 cache를 정말 많이 사용한다. 그래서 Cache 제약을 둔다. 이 말은 응답 메시지의 데이터에 캐시 가능한지, 가능하지 않은지 등에 대해 언급해야 한다. 응답 메시지가 캐시 가능하면 클라이언트 캐시는 그 메시지를 재사용할 권리가 생긴다.
        • 이의 장점은 네트워크 성능으로 이는 명확하다. 트레이드오프는 캐시가 stale한 정보를 담고 있어 최신의 상태를 담보하지 못할 수 있다는 것
        • HTTP 응답 메시지 헤더에서 데이터의 캐시 사용성에 대해 서술하는 Cache-control 헤더가 있는 것이 대표적이다.
      • Layered System(계층화)
        • Client는 REST API Server만 호출한다.
        • REST Server는 다중 계층으로 구성될 수 있다.
          • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
          • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
        • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
      • Code-On-Demand(optional)
        • Server로부터 스크립트를 받아서 Client에서 실행한다.
          반드시 충족할 필요는 없다.
      • Uniform Interface(인터페이스 일관성)
        • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
        • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
          • 특정 언어나 기술에 종속되지 않는다.
      • 공통된 인터페이스
        • REST를 다른 네트워크 기반 구조화 스타일와 차별화하는 중심적인 특징은 컴포넌트간 공통된 인터페이스의 강조다. 소프트웨어 공학의 ‘generality’를 컴포넌트 인터페이스에 적용함으로써 전체 시스템 구조가 단순해지고 상호작용간 가시성이 향상되었다. 구현은 서비스와 결합해지되어(decoupled) 독립적인 진화가 가능해졌다.
        • 단점도 물론 있다. 공통된 인터페이스는 효율을 떨어뜨린다. 어플리케이션 특화된 인터페이스를 사용하지 않기 때문.
        • REST 인터페이스는 ‘large-grain’한(‘대용량’의 뜻인 것 같다) 하이퍼미디어 데이터 전송을 효율화하기를 꾀한다. 다른 시스템에는 적용되지 않을 것
        • 공통된 인터페이스를 유지하기 위해 REST는 컴포넌트간 행동을 제약하는 4가지 추가적인 제약이 필요하다. identification of resources, manipulation of resources through representations, self-descriptive messages, hypermedia as the engine of application state

 

 

 

  • REST가 꿈꾸는 인터페이스는 HTTP와 URI를 통해 웹의 모든 컴포넌트들이 상호작용할 수 있는 표준의 인터페이스이다.
    • Layered system
      • 인터넷 단위의 요구사항을 위한 행동을 향상하기 위해 이 제약을 도입. 이 제약은 OSI 7계층 모델처럼 컴포넌트가 인접한 컴포넌트 의외의 영역을 “볼 수 없는 것처럼”한다. 이를 통해 전체 시스템 복잡도에 한계를 주고 독립성을 증진한다. 레이어는 레거시 서비스를 감싸서 새 서비스를 레거시 클라이언트로부터 보호할 수 있다.
    • Code-on-demand
      • REST는 애플렛(Applet)이나 스크립트의 형태의 코드를 다운로드하고 실행해서 클라이언트 기능성이 확장되는 것을 허용한다.

 

 


REST의 의미.



REST는 ‘REpresentational State Transfer’의 약자이다.

​ 잘 작동하는 웹 App이 어떻게 동작하는지를 이미지화해 명칭으로 축약한 것.

​ 자원을 이름으로 구분하여 해당 자원의 상태 정보를 주고 받는 것.

​ 웹 페이지들의 네트워크를 가상의 상태머신으로 두고 유저가 링크를 선택해 App을 진행시키면 상태 전이가 일어나서 다음 페이지로 가게 된다.

​ 웹 페이지의 네트워크 = 하나의 가상 상태머신. 상태머신은 유한한 상태 집합을 갖고 한 시점에 한 상 태를 지닌다.(state) 네트워크 내에서 한 웹 페이지를 한 '상태'라 표현. 그래서 유저가 링크를 선택 하면 state transfer가 발생해 다음 상태(페이지)로 넘어간다.

​ Representaional은 '표현' REST에서 Resource란 서버가 제공하는 데이터 자원인 URL로 보면 좀 부족하다. 초기 웹은 URI를 식별자로 정의해서 이 식별자를 네트워크 상에서 문서의 위치로 정의했었다. 웹 프로토콜은 URI를 통해 그 문서들을 Retrieve할 수 있었다. 하지만 이러한 관점은 다음과 같은 약점을 가진다.

 

 

  1. 이 의미는 문서가 전송될 때, 내용이 바뀌면(가령 ‘PUT’이나 ‘POST’ 메소드를 통해) 식별자도 바뀌어야 할 것 같은 느낌을 준다.
  2. 문서보다는 서비스에 더 가까운 식별자도 있다.
  3. 식별자가 주소나 정보보다는 오직 네이밍만을 위해 쓰이거나 문서가 존재하지 않을 때도 있다.하지만 REST에서는 같은 내용의 데이터를 XML, HTML, JSON의 형식에 맞게 따로 작성할 수 있듯 정보를 뜻하는 Resource와 표현하는 양식(Representation)을 분리시킨 것이다.서버에서 전송된 자원의 표현은 원 출처와 같은 표현 일 수도 있지만 다른 표현일 수도 있는데, 이는 인터페이스 뒤에 가려져 알 수 없다.온전히 같지는 않지만 '표현'의 다른 이름은 파일,문서,HTTP messege object, instance,변수 등이 있다. 그리고 그 표현의 포맷을 'Media type'이라 한다.Request and response in REST
  4. REST는 URI 표준을 '자원'으로 정의하고 그 자원을 표현으로 조작한다.
  5. REST 컴포넌트들은 자우너에 표현을 써서 자우너의 현재 또는 의도된 상태를 포착, 이 '표현'을 다른 컴포넌트에 전송한다 표현은 byte의 연속과 그 '표현'을 설명하는 meta data를 포함한다.
  6. 웹에서 활동하는 컴포넌트(서버,프록시 등)는 자원을 전소하는것이 아니라 '자원의 표현'을 전송해서 소통하는 것이다. 이때 자원의 표현은 표준화된 데이터 타입 집합 중 수령자능력이나 자원의 특성에 따라 동적으로 포맷이 선택된다. HTTP client header에서 accept를 통해 받고자 하는 자원의 표현을 지정 할 수 있는 것이 대표적이다.
  7. REST에서 Resource는 실제 가치나 문서 정보 그자체가 아니라 그에 대한 식별할 수 있는 '의미'가 된다. 이것은 웹이 하이퍼미디어 네트워크이기때문인데 하이퍼미디어에서는 일반 평문뿐 아니라 구조화된 HTML,JSON, img, video 등 다야한 형식의 데이터를 허용한다. 우리는 일반적으로 이렇게 정보와 형식을 하나로 묶어서 파일을 통으로 인식한다.

이를 통해 REST를 재정의하면

한 웹 네트워크는 전이 가능한 여러 상태를 갖는데 이때 유저가 링크를 클릭하면 URI로 매핑된 그 상태로 전이한다.(State Transfer). 이때 그 상태 정보(페이지)는 표현에 의해 조작되어 또는 전처리되어(Representational) 전송된다.

라고 할 수 있다.

 

 


REST의 장단점


  • 장점
    • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
    • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
    • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
    • Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
    • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
    • 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
    • 서버와 클라이언트의 역할을 명확하게 분리한다.
  • 단점
    • 표준이 존재하지 않는다.
    • 사용할 수 있는 메소드가 4가지 밖에 없다.
      • HTTP Method 형태가 제한적이다.
    • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
    • 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.
      • PUT, DELETE를 사용하지 못하는 점
      • pushState를 지원하지 않는 점

 


REST가 필요한 이유



  • ‘애플리케이션 분리 및 통합’
  • ‘다양한 클라이언트의 등장’
  • 최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다.
  • 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.

 

 

 


REST 구성 요소


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

 

 


RESTful API


​ REST API란 REST 규칙을 잘 이해하고 실현한 API를 말한다. 단지 우리는 REST는 단순히 URL를 만드는 규칙으로 이해하지말고 웹 프로토콜이나 App의 구조화 스타일로 이해해야한다. ex.) 카카오톡을 만들면 카카오톡만을 위한 네트워크 프로토콜이 필요하다. 이 프로토콜을 REST하게 만들자. 가 REST가 고안된 이유이다. 현실적으로는 App의 URL을 REST하게 만드는 작업이라 칭해도 무리가 없다.

REST에서의 자원의 정의는 단순한 전제로 시작한다: 식별자는 가능한 변하지 말아야 한다. 한 자원에 대한 참조(링크)를 여러 번 접근해서 정보의 내용이나 결과가 바뀔지라도 참조는 정적이어야 한다. REST는 ‘자원’이 확인하고자 하는 것에 대한 의미(semantic)라고 정의하며 실제 문서와 같은 가치, 정보라고 보지 않는다. 그렇기 때문에 가치, 정보가 변하거나, 읽히거나 심지어 삭제되어도 참조는 불변을 유지할 수 있다.

이것은 Resource가 읽히거나(READ) 생성되거나(POST), 업데이트되거나(PUT), 삭제(DELETE)되어도 URL은 자원 그자체가 아니라 의미 또는 참조이기 땜누에 변하지 않는다는 이야기다.

또 모든 HTTP기반 인터페이스는 REST가 아니다. hypertext라는 ''제약''이 있기때문에 오로지 hypertext기반이어야 RESTful하다고 할 수 있다.

REST API는 실제 웹 페이지에서 링크를 타고 내려가듯이 계층구조를 이루어야 한다.라는

'hypertext-driven'은 hypertext가 웹의 중요한 성질 중 하나인 링크를 통해 다른 페이지(state)로 전이하며 페이지와 페이지를 잇는 트리를 만들어 계층구조를 이루는 자료구조를 만든다.

즉 페이지 링크 트리를 타고 넘어가듯 URL을 작성하라는 것이 곧 hypertext-driven이다.

 

 

 

 


REST API란


  • API(Application Programming Interface)란
    • 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것
  • REST API의 정의
    • REST 기반으로 서비스 API를 구현한 것
    • 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.

 


 

REST API의 특징


  • 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
  • REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
  • 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

 

 


REST API 설계 기본 규칙


참고 리소스 원형

  • 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
  • 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
  • 스토어 : 클라이언트에서 관리하는 리소스 저장소
  1. URI는 정보의 자원을 표현해야 한다.
    1. resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
    2. resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
    3. resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
    4. resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
      • Ex) GET /Member/1 -> GET /members/1
  2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
    1. URI에 HTTP Method가 들어가면 안된다.
      • Ex) GET /members/delete/1 -> DELETE /members/1
    2. URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
      • Ex) GET /members/show/1 -> GET /members/1
      • Ex) GET /members/insert/2 -> POST /members/2
    3. 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
      • Ex) student를 생성하는 route: POST /students
      • Ex) id=12인 student를 삭제하는 route: DELETE /students/12

 

 


REST API 설계 규칙


  1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
  2. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
    • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
    • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
    • Ex) http://restapi.example.com/houses/apartments/ (X)
  3. 하이픈(- )은 URI 가독성을 높이는데 사용
    불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
  4. 밑줄(_ )은 URI에 사용하지 않는다.
    • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
  5. URI 경로에는 소문자가 적합하다.
    • URI 경로에 대문자 사용은 피하도록 한다.
    • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
  6. 파일확장자는 URI에 포함하지 않는다.
    • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
    • Accept header를 사용한다.
    • Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
    • Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
  7. 리소스 간에는 연관 관계가 있는 경우
    • /리소스명/리소스 ID/관계가 있는 다른 리소스명
    • Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

 


REST API 설계 예시


  • REST의 구체적인 개념
    • HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
      • 즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다.
      • 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.
      • CRUD Operation
        • Create : 생성(POST)
        • Read : 조회(GET)
        • Update : 수정(PUT)
        • Delete : 삭제(DELETE)
        • HEAD: header 정보 조회(HEAD)

참고 응답상태코드

  • 1xx : 전송 프로토콜 수준의 정보 교환
  • 2xx : 클라어인트 요청이 성공적으로 수행됨
  • 3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
  • 4xx : 클라이언트의 잘못된 요청
  • 5xx : 서버쪽 오류로 인한 상태코드

 

 


RESTful의 개념


RESTful이란

  • RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
    • ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
  • RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
    • 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

RESTful의 목적

  • 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
  • RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

RESTful 하지 못한 경우

  • Ex1) CRUD 기능을 모두 POST로만 처리하는 API
  • Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

결론


REST는 기존의 URL을 자원 그 자체로 보는 시야에서 벗어나서 URI는 자원을 식별하는 ‘의미’로 보고, 자원은 실제 정보와 그것을 담는 ‘표현’으로 구분함으로써 하이퍼미디어 시대에서 다양한 미디어타입을 지원함을 설명했다. 서버에서 클라이언트로는 자원이 아닌 자원의 표현이 전송되며 이렇게 링크를 통해 페이지를 옮기는 것은 곧 상태를 전이하는 것이 된다.

참고: https://shoark7.github.io/programming/knowledge/what-is-rest.html

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