REST, RESTful, REST API

✅ REST

• REST(Representational State Transfer)란, 자원의 상태 전달을 의미하는 말로, API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처이다.
• HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
• REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다. 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

✅ REST의 구성 요소

• 자원(Resource) : HTTP URI
• 자원에 대한 행위(Verb) : HTTP Method
• 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

✅ REST 아키텍처에 적용되는 제한 조건(특징)

• Client/Server 구조 : 클라이언트(사용자 인증이나 컨텍스트 관리)와 서버(API 제공)의 역할이 확실히 구분되어 각각의 역할만 수행하고 서로 의존하지 않는다.

• 무상태성(Stateless) : 클라이언트 상태를 서버에 저장하지 않는다. 서버에 들어오는 모든 요청에 대해 독립적으로 통신한다. 세션이나 쿠키와 같은 상태 정보를 저장하지 않으므로 서버에서 이러한 상태정보를 신경쓸 필요가 없으므로 구현이 단순해진다. 단점으로는 필요한 모든 정보를 각각의 요청에 전부 담은 상태로 전송해야 하므로 네트워크 성능이 저하될 수 있다.

• 캐시 가능성(Cacheable) : REST는 HTTP 웹 표준을 사용하므로, HTTP 캐시(서버 지연을 줄이기 위해 웹 페이지, 이미지, 기타 유형의 웹 멀티미디어 등의 웹 문서들을 임시 저장하기 위한 기술)를 사용할 수 있어야 한다. HTTP 캐시는 요청과 관련된 응답을 저장하고 저장된 응답을 후속 요청에 다시 사용한다.

• 계층화(Layered System) : 서버와 클라이언트 사이에 방화벽, 게이트웨이, Proxy 등 다양한 계층 형태로 구성이 가능해야 하며, 이를 확장할 수 있어야 한다. 이러한 계층은 클라이언트에 보이지 않는 상태로 유지된다.

• 인터페이스 일관성 : 인터페이스의 일관성을 지키고, 아키텍처를 단순화시켜 작은 단위로 분리하여 클라이언트, 서버가 독립적으로 개선될 수 있어야 한다. URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다. 특정 언어나 기술에 종속되지 않는다.

  • 인터페이스 일관성의 4가지 제약 조건
    1. 요청은 리소스를 식별해야 한다. 이를 위해 균일한 리소스 식별자를 사용한다. REST에서 리소스를 식별하기 위해 URI를 사용한다.
    2. 클라이언트는 표현을 추가로 처리하는 방법에 대한 정보를 수신한다. 이를 위해 서버는 클라이언트가 리소스를 적절하게 사용할 수 있는 방법에 대한 메타데이터가 포함된 명확한 메시지를 전송한다. 리소스를 조작하기 위해 데이터 전체를 전달하지 않고, 이를 메시지로 전달한다.
    3. 클라이언트는 원하는 경우 리소스를 수정하거나 삭제하기에 충분한 정보를 리소스 표현에서 가지고 있다. 서버는 리소스를 자세히 설명하는 메타데이터를 전송하여 이 조건을 충족해야한다. HTTP 기반의 REST에서는 HTTP Method와 Header 정보, URI에 포함되는 정보로 표현할 수 있음
    4. 클라이언트는 작업을 완료하는데 필요한 다른 모든 관련 리소스에 대한 정보를 수신한다. 이를 위해 서버는 클라이언트가 더 많은 리소스를 동적으로 검색할 수 있도록 리소스에 대한 Link 정보까지 포함되어야 한다.

• Code on Demand(Optional) : 자바 애플릿, 자바스크립트, 플래시 등 특정한 기능을 서버로부터 클라이언트가 전달받아 코드를 실행할 수 있어야 한다. 선택적으로 적용하며 필수는 아님.

✅ REST의 장/단점

• 장점
  ✔️ HTTP 프로토콜 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라 구축이 필요하지 않다.
  ✔️ HTTP 표준을 따르는 모든 플랫폼에서 사용 가능하다.
  ✔️ REST API 메시지를 읽는 것 만으로도 메시지가 의도하는 바를 명확하게 파악할 수 있다.
  ✔️ Stateless한 특성 때문에 이전에 서버에서 진행된 내용들을 클라이언트가 알 필요가 없기 때문에 해당 URI와 원하는 메소드 자체만 독립적으로 이해하면 된다.
  ✔️ 서버와 클라이언트의 역할이 명확하게 구분되어 있어 구현이 간단해진다.

• 단점
  ✔️ 표준이 존재하지 않는다. 즉, 관리가 어렵고 공식화 된 API 디자인 가이드가 존재하지 않는다.
  ✔️ HTTP 메소드 형태가 제한적이다.

✅ RESTful

• RESTful이란, 위의 REST 아키텍처에 적용되는 제한(특징)을 잘 준수했을 때, RESTful하다 라고한다.
• 즉, REST의 원리를 잘 준수하여 설계된 시스템을 RESTful 한 시스템(또는 API)이라고 한다.

✅ REST API

• API(Application Programming Interface)란, 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규약을 정의한 것, 데이터와 기능의 집합을 제공하여 소프트웨어간 상호작용 및 정보 교환이 가능하도록 하는 것
• REST API란, REST 아키텍처를 기반으로 한 서비스 API를 구현한 것. RESTFul API와 동일한 의미로 사용된다.

✅ REST API 설계 기본 규칙

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소

1. URI는 정보의 자원을 표현해야 한다.

• resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
• resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
• resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
• resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
• Ex) GET /Member/1 -> GET /members/1

2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.

• URI에 HTTP Method가 들어가면 안된다.
  • Ex) GET /members/delete/1 -> DELETE /members/1
• URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
  • 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

✅ REST API 설계 규칙

• 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
  • Ex) http://restapi.example.com/houses/apartments
• URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
  • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
  • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
  • Ex) http://restapi.example.com/houses/apartments/ (X)
• 하이픈(- )은 URI 가독성을 높이는데 사용
  • 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
• 밑줄(_ )은 URI에 사용하지 않는다.
  • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
• URI 경로에는 소문자가 적합하다.
  • URI 경로에 대문자 사용은 피하도록 한다.
  • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
• 파일확장자는 URI에 포함하지 않는다.
  • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
  • Accept 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’의 관계를 표현할 때)

참고 Reference

• https://aws.amazon.com/ko/what-is/restful-api/
• http://www.incodom.kr/REST#h_d19a42cef84adf14b18f549b498212de
• https://ko.wikipedia.org/wiki/REST
• https://wallees.wordpress.com/2018/04/19/rest-api-%EC%9E%A5%EB%8B%A8%EC%A0%90/
• https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html