본문 바로가기

CS지식/네트워크

[CS지식 - 네트워크] RESTful 의미와 설계규칙

 

1.  API

  • API(Application Programming Interface) : 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙 정의
  • 웹 API는 클라이언트와 웹 리소스 사이의 게이트웨이라고 생각 할 수 있음

2.  REST

  • REST(Representational State Transfer) : API작동방식에 대한 조건을 부과하는 소프트웨어 아키텍쳐의 한 형식
    (웹의 장점을 최대한 활용할 수 있는 (http를 잘 사용하기 위한) 아키텍쳐 스타일)
  • 자원(resource)의 표현에 의한 상태 전달
    1. 자원의 표현
    - 자원 : 해당 소프트웨어가 관리하는 모든 것 (ex. 문서, 그림, 데이터, 해당 소프트웨어 자체 등)
    - 자원의 표현 : 그 자원을 표현하기 위한 이름(ex. DB의 학생 정보가 자원일떄, 'students'를 자원의 표현으로 정함)
    2. 상태(정보)전달
    - 데이터가 요청되어지는 시점에서 자원의 상태(정보) 전달
    - JSON혹은 XML를 통해 데이터를 주고 받는것이 일반적
  • 구체적인 개념
    - HTTP URI를 통해 자원(Resource)를 명시하고, HTTP Method를 통해 해당 자원에 대한 CRUD operation을 적용하는 것을 의미

2-1.특징

  • 특징
    - 클라이언트 - 서버 커뮤니케이션
       요청 간에 클라이언트 정보가 저장되지 않으며, 각 요청이 분리되어 있고 서로 연결되어 있지 않음
    -Stateless(무상태)
      ▶클라이언트와 서버간 종속적x
      ▶서버는 클라이언트 정보를 저장, 유지하고 있지 않고, 같은 사람이 보낸정도와 같은 사람이 보냈는지의 정보를
         유지하고 있지 않다는 뜻
      ▶클라이언트가 요청 시 마다 자기 정보를 보내야하고 서버는 받은 정보로 클라이언트의 정보를 확인
    - Cacheable(캐시 처리 가능)
      ▶ 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용 가능
      ▶ 대량의 요청을 효율적으로 처리하기 위해 캐시 요구
      ▶ 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능
           서버의 자원 이용률을 향상 시킬 수 있음
    - Layered System(계층화)
      ▶ Client는 REST API Server만 호출
      ▶ REST Server는 다중 계층으로 구성 가능
      ▶ 프록시, 게이트웨이와 같은 네트워크 기반의 중간 매체 사용 가능

    - Code -On- Demand(optional)
      ▶ Server로부터 스크립트를 받아 Client에서 실행(반드시 충족할 필요x)
    - Uniform Interfce(인터페이스의 일관성)
      ▶ URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행
      ▶ HTTP표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능
  • 장점
    - HTTP프로토콜의 인프라를 그대로 사용하므로 REST API사용을 위한 별도의 인프라 구축 필요x
    - HTTP프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해줌
    - HTTP표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능
    - Hypermedia API의 기본을 충실히 지키면서 범용성을 보장
    - REST API메시지가 의도하는 바를 명확하게 나태내므로 의도하는 바를 쉽게 파악 가능
    - 여러가지 서비스 디자인에서 생길 수 있는 문제 최소화
    - 서버와 클라이언트 역할 명확히 분리
  • 단점
    - 표준이 존재하지 않음
    - 사용할 수 있는 메서드 4가지
      ▶ HTTP Method형태가 제한적
    - 구형 브라우저가 아직 제대로 지원해주지 못하는 부분 존재
      ▶ PUT, DELETE사용x
      ▶ pushState 지원x

2-2. REST가 필요한 이유

  • 애플리케이션 분리 및 통합
  • 다양한 클라이언트의 등장
  • 최근 서버 프로그램은 다양한 브라우저 안드로이드, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야함

2-3. REST 구성요소

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

3. REST API

  • REST한 방식으로 데이터를 상호교환하게 설계된 API
    ▶HTTP를 잘사용하기 위해, URI와 HTTP메소드를 잘 사용해서, URL로 어떤 자원에 접근 할 것인지
        메소드로 어떤 행위를 할 것인지 표현하여 설계된 API
  • RESTful API는 안전하고 신뢰할 수 있으며 효율적인 소프트웨어 통신 표준을 따르며 정보교환을 지원
  • 특징
    - 확장성과 재사용성을 높여 유지보수 및 운용을 편리 하게 할 수 있음
    - HTTP표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램언어로 클라이언트, 서버 구현 가능

3-1. REST API 설계 기본 규칙

  1. URI 정보의 자원을 표현해야함
  2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현

3-2. REST API 설계 규칙

  1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용
  2.  URI 마지막 문자로 슬래시(/)를 포함하지 않음
  3. 하이픈(-)은 URI의 가독성을 높이는데 사용
  4. 밑줄(_)은 URI에 사용하지 않음
  5. URI경로는 소문자가 적합
  6. 파일 확장자는 URI에 포함하지 않음

4.  RESTful API

  • 정의
    - REST라는 아키텍처를 구현한 웹 서비스를 나태내기 위해 사용되는 용어
      ▶ REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있음
  • 목적
    - 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
    -근본적 목적 : 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는것
      ▶ 성능이 중요한 상황에서는 굳이 RESTful한 API구현 할 필요x
  • RESTful 하지 못한 이유
    -ex) CRUD 기능을 모두 POST로만 처리하는 API
    -ex) route에 resource,id 외의 정보가 들어간 경우(/students/updateName)
더보기