REST API란? REST, RESTful API 개념 정리

 

---

개요

 

블로그를 작성하면서 많이 나오는 용어인 REST API에 대해서 알아보도록 하겠습니다.

REST는 웹에서 데이터를 전송하고 처리하는 방법을 정의한 인터페이스를 말한다. 모든 데이터 구조와 처리방식은 REST에서 URL을 통해 정의되며, 그래서 매우 직관적으로 이해하기 쉽다. 이는 대중에게 서비스를 제공할 때 좀 더 쉽게 다가갈 수 있도록 하는 요소이기도하다.

 

---

REST API  (Representational State Transfer API)

 

REST API란 REST를 기반으로 만들어진 API를 의미합니다. 

REST API를 알기 위해 REST가 무엇인지부터 알아보도록 하겠습니다.

 

 

---

REST란?

 

 

REST (Representational State Transfer)의 약자로 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미합니다.

 

즉 REST란

HTTP URI를 통해 자원을 명시하고,

HTTP Method (POST, GET, PUT, DELETE)를 통해

해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미합니다.

 

 

---

REST 구성 요소

 

REST는 구성요소는 크게 3가지로 구성이 되어있습니다.

1. 자원(Resource) : HTTP URI

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

3. 자원에 대한 행위의 내용 : (Representations) : HTTP Message Pay Load

 

 

---

REST의 특징

 

• Uniform (유니폼 인터페이스)
  • HTTP 표준에만 따른다면, 안드로이드/IOS 플랫폼이든, 특정 언어나 기술에 종속되지 않고 모든 플랫폼에 사용할 수 있으며, URI로 지정한 리소스에 대한 조작이 가능한 아키텍처 스타일을 의미한다.

 

• Stateless (무상태성)
  
  • REST는 무상태성 성격을 가진다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 그래서 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

 

• Cacheable (캐시 기능)
  • REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능이 적용할 수 있다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

 

• Self-descriptiveness (자체 표현 구조)
  • REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다는 것이다.

 

• Client - Server 구조
  • REST 서버는 API 제공, 클라이언트는 사용자 인증이나 콘텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로 간 의존성이 줄어들게 된다.

 

• 계층형 구조
  • REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있게 한다.

 

 

---

REST의 장단점

 

장점

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

 

단점

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

 

 

---

REST API란?

 

 

REST API란?

API(Application Programming Interface) 란 REST의 원리를 따르는 API를 의미한다.

 

• API란 클라이언트가 리소스를 요청할 수 있도록 서버 측에서 제공된 인터페이스(interface)를 말한다.
• 이러한 API로 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램 간 상호작용을 촉진하며, 서로 정보를 교환 가능하도록 한다.
• 서버를 개발한다는 것은 API에 대한 마스터 권한이 생기는 것이다.
• API와 함께 항상 매뉴얼도 제공되어야 한다. URI를 모르면 클라는 사용할 수 없다.

 

 

---

REST API 설계 규칙

 

1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

Bad Example : http://Jung-story.com/logging/ Good Example : http://Jung-story.com/login/

 

2. 마지막에 슬래시 (/)를 포함하지 않는다.

Bad Example : http://Jung-story.com/inqurey/ Good Example : http://Jung-story.com/inqurey

 

3. 언더바 대신 하이폰을 사용한다.

Bad Example :http://Jung-story.com/test_login Good Example :http://Jung-story.com/test-login

 

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

Bad Example :http://Jung-story.com/picture.jpg Good Example :http://Jung-story.com/picture

 

5. 행위를 포함하지 않는다.

Bad Example :http://Jung-story.com/delete-inqurey/2 Good Example :http://Jung-story.com/inquery/2

 

 

응답코드

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

 

 

---

RESTful이란?

 

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어입니다.

'REST API'를 제공하는 웹 서비스를 'RESTful' 하다고 할 수 있습니다.

 

RESTful은 REST를 REST 답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아닙니다.

즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭됩니다.

 

 

---

RESTful의 목적

 

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것.

RESTful 한 API를 구현하는 근보적인 목적이 성능 향상에 있는 것이 아니라 일괄적인 컨벤션을 통한 API의 이해도 및  호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

 

 

---

RESTful 하지 못한 경우

 

CRUD 기능을 모두 POST로만 처리하는 API

URI 규칙을 올바르게 지키지 않은 API

 

 

---