RESTful

Posted by Casval's Storage on November 23, 2020

REST

  • Representational State Transfer
    • 자원을 이름(표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 것을 의미
    • 자원(resource)의 표현(representation)에 의한 상태 전달
      • 자원(resource)의 표현(representation)
        • 자원: 해당 소프트웨어가 관리하는 모든것 (file, 그림, 데이터, SW 자체)
        • 표현: 자원을 표현하기 위한 이름
          • db의 학생 정보가 자원이면 students를 자원의 표현이라 함.
      • 상태 전달
        • 데이터가 요청되어지는 시점에서 자원의 상태를 전달
        • JSON or XML을 통해 데이터를 주고받는 방식이 일반적
    • 소프트웨어 개발 아키텍처의 한 형식
      • 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대로 활용할 수 있는 아키텍처 스타일 이다.
  • 개념
    • HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)를 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD 작업을 적용
  • 장단점
    • 장점
      • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
      • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함게 가져갈 수 있다.
      • HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용 가능
      • Hypermedia API(?)의 기본을 충실히 지키면서 범용성을 보장.
      • REST API 메시지가 의도하는 바를 명확히 나타낸다.
      • 서버와 클라이언트의 역할을 명확히 구분
    • 단점
      • 표준이 없다.
      • 사용가능한 메소드가 4개 밖에 없다.
      • 구형 브라우저가 아직 제대로 지원해주지 못하는 부분 존재
        • PUT, DELETE, pushState
  • 필요성
    • 다양한 클라이언트, 다양한 브라우저, 다양한 모바일 디바이스에서 통신할 수 있어야 함.
    • 멀티 플랫폼 지원을 위해 쉽게 사용가능 한 통합된 규칙이 필요
  • 특징
    • Server-Client
      • 자원(Server) - API를 제공, 비지니스 로직 처리, 저장
      • 요청(Client) - 사용자 인증, context(session, login) 등을 관리
    • Stateless
      • HTTP 프로토콜이 Stateless Protocol -> REST도 Stateless
      • Client의 context를 Server에 저장하지 않음.
        • 세션, 쿠키 같은 context 정보를 신경쓰지 않아 server가 구현이 쉬워짐
      • Server는 각각의 요청을 완전 별개의 것으로 인식하고 처리
        • 이전 요청이 다음 요청의 처리에 연관되지 않음.
        • Server의 처리 방식에 일관성 부여, 서비스 자유도 상승
    • Cacheable
      • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다. 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
      • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
    • Layered System(계층화)
    • Code-On-Demand
    • Uniform Interface(인터페이스 일관성)
      • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
      • 특정 언어나 기술에 종속되지 않고 HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용 가능.

REST API

  • REST 기반으로 서비스 API를 구현한 것

설계 기본 규칙

리소스 종류

  • 도큐먼트: 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
  • 컬렉션: 서버에서 관리하는 디렉토리
  • 스토어: 클라이언트에서 관리하는 리소스 저장소
  1. URI는 정보의 자원을 표현하며 표현 규칙은 다음과 같다.
    1. 동사보다 명사, 대문자보다 소문자
    2. 도큐먼트 이름으로는 단수 명사
    3. 컬렉션 이름으로는 복수 명사
    4. 스토어 이름으로는 복수 명사
  2. 자원에 대한 행위는 HTTP Method(POST, GET, PUT, DELETE)로 표현하며 규칙은 다음과 같다.
    1. URI에 HTTP Method가 들어가면 안된다.
      • GET /members/delete/1 (x) GET /members/1(O)
    2. URI에 행위에 대한 동사 표현이 들어가면 안된다.
      • GET /members/show/1(X) GET /members/1 (O)
      • GET /members/insert/2(X) POST /members/2(O)
    3. 경로 부분 중 변하는 부분은 유일한 값으로 대체
      • student를 생성하는 route: POST /students
      • id=12인 student를 삭제하는 route: DELETE /students/12
    4. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용
      • http://restapi.example.com/houses/appartments
    5. URI 마지막에 슬래시(/)를 포함하지 않는다.
    6. 하이폰 (-)은 URI 가독성을 높이는데 사용
    7. 밑줄(_)은 URI에 사용하지 않는다.
    8. URI 경로에는 소문자가 적합하다.
    9. 파일 확장자는 URI에 포함하지 않는다.
    10. 리소스간 연관관계 푷ㄴ
      • /리소스명/id/관계가 있는 다른 리소스명
      • GET : /users/{userid}/devices (has 관계)