[Network] REST API란?

REST의 개념

REST란?

REST의 정의

• Representational State Transfer의 약자
  - 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.
  • 자원: 해당 소프트웨어가 관리하는 모든 것
    ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
  • 데이터가 요청되는 시점에서 자원의 상태(정보)를 전달한다.
  • JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적이다.
• 월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식이다.
  • REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
  • REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.

즉, REST란
1. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
2. HTTP Method(POST, GET, PUT, DELETE)를 통해
3. 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

• 즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고, HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다.
• 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

CRUD Operation이란
CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말로
REST에서의 CRUD Operation 동작 예시는 다음과 같다.

CRUD Operation 동작 예시

• Create: 데이터 생성(POST)
• Read: 데이터 조회(GET)
• Update: 데이터 수정(PUT, PATCH)
• Delete: 데이터 삭제(DELETE)

REST의 장단점

장점

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

단점

• 표준이 존재하지 않아 정의가 필요하다.
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
• 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다. (Explorer)

REST가 필요한 이유

• 애플리케이션 분리 및 통합
• 다양한 클라이언트의 등장
• 최근의 서버 프로그램은 다양한 브라우저와 모바일 디바이스에서도 통신 가능해야 한다.
• 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 됨
  
  

REST 구성 요소

REST는 다음과 같은 3가지로 구성되어 있다.

1. 자원(Resource): HTTP URI

   • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
   • 자원을 구별하는 ID는 '/groups/:group_id'와 같은 HTTP URI이다.
   • Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

2. 자원에 대한 행위(Verb): HTTP Method

   • HTTP 프로토콜의 Method를 사용한다.
   • HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다.

3. 행위의 표현(Representation of Resource): HTTP Message Pay Load

   • Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
   • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어질 수 있다.
   • JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적이다.

REST의 특징

1. Server-Client(서버-클라이언트 구조)

   • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
     • REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
     • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   • 서로 간의 의존성이 줄어든다.

2. Stateless(무상태)

   • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
   • Client의 context를 Server에 저장하지 않는다.
     • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
   • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
     • 각 API 서버는 Client의 요청만을 단순 처리한다.
     • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안 된다.
     • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
     • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

3. Cacheable(캐시 처리 가능)

   • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
     • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
     • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
   • 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
   • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

4. Layered System(계층화)

   • Client는 REST API Server만 호출한다.
   • REST Server는 다중 계층으로 구성될 수 있다.
     • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
     • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
   • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

5. Code-On-Demand(optional)

   • Server로부터 스크립트를 받아서 Client에서 실행한다.
   • 반드시 충족할 필요는 없다.

6. Uniform Interface(인터페이스 일관성)

   • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
   • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
     • 즉, 특정 언어나 기술에 종속되지 않는다.

REST API의 개념

REST API란?

• API(Application Programming Interface)란?
  데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환 가능하도록 하는 것이다.
  
  

REST API의 특징

• REST 기반으로 서비스 API를 구현한 것이다.
• 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.
  
  

REST API 설계 규칙

1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.

   http://restapi.example.com/houses/apartments

2. URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
   - URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 한다.
   - REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.

   http://restapi.example.com/houses/apartments/ (X)

3. 하이픈(-)은 URI 가독성을 높이는데 사용한다.
   • 불가피하게 긴 URI 경로를 사용하게 될 경우, 하이픈을 사용해 가독성을 높인다.
4. 밑줄(_)은 URI에 사용하지 않는다.
5. URI 경로에는 동사보다는 명사를, 대문자보다는 소문자를 사용해야 한다.

   http://restapi.example.com/sports/Running (X)
   http://restapi.example.com/sports/run (O)

6. 파일확장자는 URI에 포함하지 않는다.

   http://restapi.example.com/members/soccer/345/photo.jpg (X)

• REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
  • Accept header를 사용한다.
    GET/members/soccer/345/photo HTTP/1.1 Host:restapi.example.com Accept: image/jpg (O)

7. 리소스 간에는 연관 관계가 있는 경우
   • /리소스명/리소스 ID/관계가 있는 다른 리소스명
   • ex) GET:/users/{userid}/devices (일반적으로 소유 'has'의 관계를 표현할 때)

REST API 설계 예시

CRUD	HTTP verbs	Route
resource들의 목록을 표시	GET	/resource
resource 하나의 내용을 표시	GET	/resource/:id
resource를 생성	POST	/resource
resource를 수정	PUT	/resource/:id
resource를 삭제	DELETE	/resource/:id

참고 응답상태 코드

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