What is a REST API? RESTful API?

 

API, REST API, RESTful API 등등 여기저기서 줍줍하여 들어보긴 했지만, 명확하게 이거이거에요 라고 설명하기 어려웠던 부분이에요 (저에겐^^)

 

 

🍎 API란? 

'한 프로그램에서 다른 프로그램으로 데이터를 주고받기 위한 방법' 이라고 할 수 있죠 

Application Programming Interface의 약자인데 풀어써도 어려운게 함정.. 

 

손님-점원-요리사로 많이들 비유하시는데, 손님이 자리에 앉아서 점원에게 주문을 하면 점원은 주문내역을 요리사에게 전달하죠? 요리가 끝나면 점원이 다시 손님에게 음식을 가져다 주고요. 이럴 때 중간 매개체 역할을 하는 점원이 'API'라고 할 수 있습니다. 

 

즉 손님과 요리사를 서버라고 한다면 API는 중간에서 양쪽 서버를 연결해 주는거죠 

 

 

🍎 REST란?

그렇다면 REST란 무엇일까요?

REpresentational State Transfer의 약자인데요, 직역하자면 어떤 상태의 표현을 주고 받는다라는 뜻입니다. 

 

HTTP URI를 통해 자원을(문서, 그림, 데이터, 소프트웨어 자체 등) 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미합니다. 어려운 것 같지만 HTTP Method와 CRUD등에 대해 공부하면 아마 한번에 이해하실 수 있을거에요. 

 

 

🍎 REST의 특징

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

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

 

2. Stateless (무상태성)

• 작업을 위한 상태정보를 따로 저장하거나 관리하지 않습니다. 세션 정보나 쿠키 정보를 별도로 저장하거나 관리하지 않기 때문에 API서버는 들어오는 요청만을 단순히 처리하면 됩니다. 
• 따라서 서비서의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

 

3. Cacheable (캐시 가능)

• 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있습니다. 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있습니다.
• 대량의 요청을 효율적으로 처리할 수 있습니다.

 

4. Self-descriptiveness (자체 표현 구조) 

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

 

5. Client - Server 구조

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 됩니다. 
• 역할이 확실하게 구분되기 때문에 개발해야 할 내용이 명확해지고 서로 간 의존성이 줄어들게 됩니다

 

6. Layered System (계층 구조) 

• 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있습니다.
• Proxy, Gateway와 같은 네트워크 기반의 중간매체를 사용할 수 있습니다. 

 

 

🍎 REST API란?

그렇다면 REST API가 무엇인지 대충 감이 오시죠 ?

REST의 특징을 기반으로 서비스 API를 구현한 것이 REST API 입니다. 

 

최근 OpenAPI등을 제공하는 기업 대부분은 REST API를 제공합니다. REST API의 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지 그 모습 자체로 추론이 가능한 것입니다.

 

 

🍎 REST API 설계 규칙

REST API 설계할 때는 규칙이 있는데요, 가장 중요한 항목은 아래의 2가지 입니다.

 

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

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

 

 

1. URI는 명사를 사용한다. (리소스명은 동사가 아닌 명사를 사용해야 합니다.) 

 

2. 슬래시( / )로 계층 관계를 표현한다.

http://www.fruits-basket.com/fruits/banana

 

3. URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.

http://www.fruits-basket.com/fruits/banana/ (X)

 

4. 밑줄( _ )을 사용하지 않고, 하이픈 ( - ) 을 사용한다.

http://www.fruits-basket.com/tropical_fruits/banana (X) 
http://www.fruits-basket.com/tropical-fruits/banana (O)

 

5. URI는 소문자로만 구성한다. 

 

6. HTTP 응답 상태 코드 사용 - 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야 한다.

 

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

 

 

🍎 RESTful API란?

RESTful API는 REST의 설계 규칙을 잘 지켜서 설계된 API를 말합니다. 

즉, REST의 원리를 잘 따르는 시스템을 RESTful이라는 용어로 지칭하는 것이죠. 

 

RESTful 하게 만든 API는 요청을 보내는 주소만으로도 어떤 것을 요청하는지 파악이 가능합니다.