[CS] REST API

LILO Ghim·2022년 2월 4일
1

개념이해의 순서

Architecture Style → REST(정의, 원칙) → REST API(정의, 구성, 디자인 가이드)


웹을 위한 네트워크 기반 아키텍처 스타일

Architecture Style(아키텍처 스타일) : 특정한 특성을 공유하는 아키텍처의 집합(제약 조건들의 집합)

  • 네트워크 기반 애플리케이션 아키텍처
    • 성능
    • 규모확장성(Scalability)
    • 단순성
    • 수정용이성(Modifiability)
    • 가시성(Visibility)
    • 이식성(Portability)
    • 신뢰성(Reliability)

REST

REST : REpresentational State Transfer

웹 아키텍처의 요구사항, 해결해야 할 문제를 설명하고 이를 해결하기 위한 접근방법

이 접근 방법의 결과물 == 웹을 위한 아키텍처 스타일 == REST

  • REST 6 가지 원칙
    1. Uniform Interface (균일한 인터페이스)

      • 구성요소(클라이언트, 서버 등) 사이의 인터페이스는 균일해야 한다.
      • 인터페이스의 일반화 → 전체 시스템 아키텍처가 단순해진다 → 상호작용의 가시성 개선 → 구현과 서비스의 분리 : 독립적인 진화
      • 제약조건
        • identification of resources
        • manipulation of resources through representation
        • self-descriptive messages
        • hypermedia as the engine of application state
      • URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일
    2. Stateless (무상태성)

      • 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다 → 규모확장성 개선
      • 모든 요청은 필요한 모든 정보를 담고 있어야 한다 → 요청 하나만 봐도 바로 알 수 있도록 → 가시성 개선
      • task 실패시 복원이 쉽다 → 신뢰성 개선
      • 세션정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에, API 서버는 들어오는 요청만을 단순히 처리 → 자유도가 높아진다 → 서버에서 불필요한 정보를 관리하지 않기 때문에 구현이 단순해진다
    3. Cacheable (캐시 가능)

      HTTP라는 기존 웹표준을 그대로 사용하므로 웹에서 사용하는 기존 인프라를 그대로 활용 가능

      → 캐싱기능 적용가능 : HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능

      → 효율, 규모확장성, 사용자 입장에서 성능 개선

      참고)

      더 빠른 웹을 위하여 - 웹 캐쉬 (WEB CACHE)

      • 요약

    4. self-descriptiveness (자체표현 구조)

      REST API 메세지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것

    5. Client - Server

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

    6. Hierarchical Layers (계층형 구조)

      • 각 레이어에 속한 구성요소는 인접하지 않은 레이어의 구성요소를 볼 수 없어야 한다
      • REST 서버는 다중 계층으로 구성될 수 있으며, 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있다
      • PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다

REST API 구성

자원(RESOURCE) - URI
행위(Verb) - HTTP Method
표현(Representations)

  • RESTful하다 REST의 기본원칙을 성실히 지킨 서비스
  • Resource Oriented Architecture
    • API 설계의 중심에 자원(Resource)이 있고, HTTP Method를 통해 자원을 처리하도록 설계

REST API 디자인 가이드

  • URI는 정보의 자원(resource)를 표현(representations)

  • 자원(resource)에 대한 행위(Verb)는 HTTP Method(GET, POST, PUT, DELETE)로 표현(representations)

  • REST API 중심 규칙

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

      GET /members/delete/1 #x
       DELETE /members/1     #ok

      URI는 자원을 표현하는데 중점을 두어야 하므로, 행위에 대한 표현이 들어가면 안됨

      자원(resource)에 대한 행위(verb)는 HTTP Method로 표현(representations)

      == RESTful 한 API 설계

    2. URI 설계 시 주의할 점

      • 슬래시(/)는 계층 관계를 나타내는 데 사용
        • URI 마지막 문자로 슬래시(/)를 포함하지 않는다
      • 하이픈(-)은 URI 가독성을 높이는 데 사용
        • 불가피하게 긴 URI 경로를 사용하게 된다면 가독성을 높이기 위해 사용
      • 밑줄(_)은 사용하지 않는다
      • 소문자
      • 파일 확장자는 포함시키지 않는다
      • 메세지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 포함시키지 않는다 → Accept header
        GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg
    3. 리소스 간의 관계를 표현하는 방법

      /리소스명/리소스 ID/관계가 있는 다른 리소스명
      
      GET /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
      
      GET /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)
    4. 자원을 표현하는 Collection과 Document

      Document : 하나의 객체 / Collection : Document(객체)의 집합 → 둘다 리소스 → URI에 표현

      collection은 복수로 사용, 객체는 document는 단수로 사용

      http:// restapi.example.com/sports/soccer
       http:// restapi.example.com/sports/soccer/players/13
  • HTTP 상태코드 잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함 정확한 응답 상태 코드만으로도 많은 정보를 전달 할 수 있기 때문 (링크추가)
profile
킴릴로

0개의 댓글