Rest API

• REST란
  • "Representational State Tanster"의 약자
  • 자원을 이름(URI)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 방법론을 의미
• REST의 구성
  • 자원 (Resorce) - URI
    모든 자원은 고유한 ID를 가지고 ID는 서버에 존재하고 클라이언트는 각 자원의 상태를 조작하기 위해 요청을 보낸다. HTTP에서 이러한 자원을 구별하는 ID는 'users/{id}' 같은 HTTP URI이다.
  • 행위 (Verb) - HTTP Method
    클라이언트는 URI를 이용해 자원을 지정하고 자원을 조작하기 위해 Method를 사용한다. HTTP 프로토콜에서는 GET, POST, PUT, DELETE 같은 Method를 제공한다.
    
    
  • 표현 (Representations) - Payload
    클라이언트가 서버로 요청을 보냈을 떄 서버가 응답으로 보내주는 자원의 상태를 Representation이라고 한다. REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타낼 수 있다.
  • ex) GET users/{id} 
• CRUD Operation, HTTP Method
  1. Create : POST (자원 생성)
  2. Read : GET (자원 정보 조회)
  3. Update : PUT (자원의 정보 업데이트)
  4. Delete : DELETE (자원 삭제)
• REST의 특징
  
  1. 유니폼 인터페이스 : HTTP 표준에만 따른다면, Android/IOS/웹 등 어떤 플랫폼에서 사용해도 사용이 가능한 인터페이스 스타일이다. 특정 언어에 상관없이 사용이 가능
  2. Stateless(무상태성) : HTTP는 Stateless Protocol 이므로, REST 역시 무상태성을 갖는다. HttpSession과 같은 컨텍스트 저장소에 상태정보를 따로 저장하고 관리하지 않고, API 서버는 들어오는 요청만을 단순 처리하면 된다. 세션과 같은 컨텍스트 정보를 신경쓸 필요가 없어 구현이 단순해진다.
  3. Cacheable (캐시가능) : HTTP 기존의 웹 표준을 그대로 사용하므로, 웹에서 사용하는 기존의 인프라를 그대로 활용 가능하다. HTTP 프로토콜 기반의 로드밸런서(mod_proxy)나, SSL은 물론이고 HTTP가 가진 가장 강력한 특징 중의 하나인 캐싱 기능을 적용할 수 있다. 일반적인 서비스에서 조회 기능이 주로 사용됨을 감안하면, HTTP 리소스들을 웹 캐쉬 서버 등에 캐싱하는 것은 용량이나 성능면에서 이점이 있다. 캐싱 구현은 HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 가능하다.
  4. Self-descriptiveness (자체 표현 구조) : 동사(Method) + 명사(URI)로 이루어져 있어 어떤 메서드에 무슨 행위를 하는지 알 수 있으며, 메시지 포맷 역시 JSON을 이용해서 직관적으로 이해가 가능한 구조로, REST API 메시지만 보고도 이를 쉽게 이해할 수 있다.
  5. Client - Server 구조 : REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보 등)을 직접 관리하는 구조로 각가의 역할이 확실ㅇ히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.
  6. 계층형 구조 : API 서버는 순수 비즈니스 로직을 수행하고, 그 앞단에 사용자 인증, 암호화(SSL), 로드밸런싱 등을 하는 계층을 추가하여 구조상의 유연성을 둘 수 있다. 이는 간단하게는 HA Proxy나 Apache의 Reverse Proxy를 통해, 더 나아가서는 API gateway 등을 활용하여 Micro Service Architecture로도 구현이 가능하게 한다.
• REST의 장단점
  • 장점
    1. 쉬운 사용
       HTTP 프로토콜 인프라를 그대로 사용하므로 별도의 인프라를 구축할 필요가 없다.
    2. 클라이언트 - 서버 역할의 명확한 분리
       클라이언트는 REST API를 통해 서버와 정보를 주고 받는다. REST의 특징인 Stateless에 따라 서버는 클라이언트의 Context를 유지할 필요가 없다.
    3. 특정 데이터 표현을 사용가능
       REST API는 헤더 부분에 URI 처리 메소드를 명시하고 필요한 실제 데이터를 'body'에 표현할 수 있도록 분리 시켰다. JSON, XML 등 원하는 Representation 언어로 사용가능하다.
       
       
  • 단점
    1. 메소드의 한계
       REST는 HTTP 메소드를 이용하여 URI를 표현한다. 이러한 표현은 쉬운 사용이 가능하다는 장점이 있지만 반대로 메소드 형태가 제한적인 단점이 있다.
    2. 표준이 없음
       REST는 설계 가이드일 뿐이지 표준이 아니다.
• URI 설계시 주의할 점
  1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용
  2. URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
  3. 하이픈(-)은 URI 가독성을 높이는데 사용
  4. 밑줄(_)은 URI에 사용하지 않는다.
  5. URI 경로에는 소문자가 적합하다
  6. 파일확장자는 URI에 포함하지 않는다.