REST API

REST, Representational State Transfer

자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.

네트워크상에서 Client와 Server 사이의 통신 방식 중 하나다.

• 자원 : 해당 소프트웨어가 관리하는 모든 것예) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
• 표현 : 그 자원을 표현하기 위한 이름예) DB의 학생 정보가 자원일 때, ‘students’가 자원의 표현
• 상태(정보) 전달: 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달, JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적

 

※ 상세 설명

• HTTP URL(Uniform Resource Identifier)을 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미
  ↓
  REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처를 의미
  
• 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URL를 부여

 

※ 장단점

장점

1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
2. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
3. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
4. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
5. REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
6. 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
7. 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

1. 표준이 존재하지 않는다.
2. 사용할 수 있는 메소드가 4가지 밖에 없다.HTTP Method 형태가 제한적이다.
3. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 더 어렵게 느껴진다.
4. 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다..
   • PUT, DELETE를 사용하지 못하는 점
   • pushState를 지원하지 않는 점

 

※ 사용 이유

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

 

※ 구성요소

• 자원(Resource): URL
  • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URL이다.
  • Client는 URL를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 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를 통해 데이터를 주고 받는 것이 일반적이다.

 

※ 특징

• 서버-클라이언트 구조
  • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
    • REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
    • Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
  • 서로간 의존성이 줄어든다.
• 무상태(Stateless)
  • 서버는 클라이언트를 식별할 수 없는 특성, 클라이언트의 상태를 모른다.
  • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
  • Client의 context를 Server에 저장하지 않는다.
    • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
  • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
    • 각 API 서버는 Client의 요청만을 단순 처리한다.
    • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
    • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
    • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.
• 캐시 처리 기능
  • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
    • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
    • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태스나 E-Tag를 이용하면 캐싱 구현이 가능하다.
  • 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
  • 캐시 사용을 통해 응답시간이 빨리지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
• 계층화
  • Client는 REST API Server만 호출한다.
  • REST Server는 다중 계층으로 구성될 수 있다.
    • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
    • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
      • 로드밸런싱: 서버가 처리해야 할 업무, 요청(Load)을 여러 대의 서버로 나누어(Balancing) 처리하는 것
  • PROXY, 게이트웨어 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
• Code-On-Demand
  • Server로부터 스크립트를 받아서 Client에서 실행한다.
  • 반드시 충족할 필요는 없다. (Optional)
• 인터페이스 일관성
  • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
    • 특정 언어나 기술에 종속되지 않는다.

---

REST API

REST 기반으로 서비스 API를 구현하는 것

• API, 클라이언트가 리소스를 요청할 수 있도록 서버측에서 제공된 인터페이스(interface)

 

※ 특징

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

 

※ 설계 규칙

• 참고 리소스 원형
  • 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
  • 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
  • 스토어 : 클라이언트에서 관리하는 리소스 저장소
• URL 정보는 자원을 표현
  • resource는 동사보다는 명사를, 대문자 보다는 소문자를 사용한다.
  • resource의 도큐먼트 이름으로는 단수 명사를 사용해야한다.
  • resource의 컬렉션 이름으로는 복수 명사를 사용해야한다.
  • resource의 스토어 이름으로는 복수 명사를 사용해야한다.
    • Ex) GET /Member/1 → GET /members/1
• 자원에 대한 행위는 HTTP Method로 표현
  • URL에 HTTP Method가 들어가면 안된다.
    • Ex) GET /members/delete/1 → DELETE /members/1
  • URL에 행위에 대한 동사 표현이 들어가면 안된다. (즉, CRUD 기능을 나타내는 것은 URL에 사용하지 않는다.)
    • Ex) GET /members/show/1 → GET /members/1
    • Ex) GET /members/insert/2 → POST /members/2
  • 경로 부분 중 변화하는 부분은 유일한 값으로 대체한다. (즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
    • Ex) student를 생성하는 route : POST /students
    • Ex) id=12인 student를 삭제하는 route : DELETE /students/12
• 슬래시 구분자(/)는 계층 관계를 나타내는데 사용
• URL 마지막 문자로 슬래시(/)를 포함하지 않는다.
  • URL에 포함되는 모든 글자는 리소스의 유일한 식별자이기에, URL가 다르다는 것은 리소스가 다르다는 것이다.
  • REST API는 분명한 URL를 만들어 통신해야 하기에, URL 경로의 마지막에 슬래시(/ )를 사용하지 않는다.
• 하이픈(-)은 URL 가독성을 높이는데 사용
  • 긴 URL경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
• 밑줄(_)은 URL에 사용하지 않는다.
• URL 경로에는 소문자를 사용한다.
  • PFC 3986(URL 문법 형식)은 URL 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.
• 파일확장자는 URL에 포함하지 않는다.
  • Accep 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)
• 리소스간 연관 관계 표현
  • /리소스명/리소스 ID/관계가 있는 다른 리소스명
  • Ex) GET : /users/{userid}/devices (일반적으로 소유 'has'의 관계를 표현할 때)

 

※ 응답상태코드

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

---

RESTful

REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어

• REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있다.
• REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

 

※ 목적

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

 

※ RESTful 하지 못한 경우

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

 

 

 

 

 

Reference
[1] https://hanamon.kr/rest-api/