240521 TIL : REST, REST API, RESTful

1. REST 란?

REST는 Represnetational State Transfer의 약자로 www과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식이다.

 

• HTTP URI를 통해 자원을 명시하고, HTTP Method를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것

HTTP Method : POST, GET, PUT, DELETE, PATCH

 

CRUD Operation : 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create, Read, Update, Delete를 묶어서 말한다.

 

- Create : 데이터 생성(POST)

- Read : 데이터 조회 (GET)

- Update : 데이터 수정(PUT, PETCH)

- Delete : 데이터 삭제 (DELETE)

 

1) REST의 구성요소

 

1. 자원(Resource) : HTTP URI

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

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

• HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드 제공

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

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

 

2) REST의 특징

1. Server-Client
   • 자원이 있는 쪽 : Server, 자원을 요청하는 쪽 : Client
   • Client와 Server를 분리해서 독립적으로 발전시킬 수 있다.
   • Client는 UI와 UX를 담당하고 Server는 데이터 저장 및 처리를 한다.
2. Stateless (무상태)
   • 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.
   • 세션정보나 쿠키정보를 별도로 저장하고 관리하지 않아 API서버는 들어오는 요청만을 단순히 처리하면 된다.
   • 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
3. Cacheable (캐시 가능)
   • HTTP 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라 활용 가능 → 캐싱 기능 적용 가능
   • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능
4. Layered System (계층화)
   •  REST Server는 다중 계층으로 구성 가능
   • 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 만들 수 있다.
   • PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.
   • 이 계층들은 클라이언트에 보이지 않는 상태로 유지한다.
5. Uniform Interface (인터페이스의 일관성)
   • 리소스에서 수행할 수 이쓴 작업의 균일한 인터페이스를 정의한다.
   • GET, POST, PUT, DELETE와 같은 HTTP Method를 사용해서 구현된다.
6. Code on demand
   • 서버에서 소프트웨어 프로그래밍 코드를 클라이언트에 전송하여 클라이언트 기능을 일시적으로 확장할 수 있다.

 

3) 장점과 단점

장점

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

단점

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

 

---

 

2. REST API

REST API란 REST의 원리를 따르는 API

 

API(Application Programming Interface) : 클라이언트, 서버와 같은 서로 다른 프로그램에서 요청과 응답을 주고받을 수 있게 만든 체계

 

- 서버 개발자가 개발하고, 클라이언트 개발자가 사용

 

참고 문서 : https://tech.kakaoenterprise.com/127

1) REST API 설계 규칙

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

X : http://lsb.com/Writing/
O :  http://lsb.com/write/  

 

2. 마지막에 /를 포함하지 않는다.

X :  http://lsb.com/text/
O :  http://lsb.com/text

 

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

X :  http://lsb.com/test_log
O :  http://lsb.com/test-log 

 

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

X :  http://lsb.com/text.txt
O :  http://lsb.com/text 

 

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

X :  http://lsb.com/delete-post/1
O :  http://lsb.com/post/1 

 

 

---

 

3. RESTful 

REST 원리를 따르는 시스템을 의미 → 'REST API'를 제공하는 웹서비스를 'RESTful'하다고 할 수 있다.

 

1) RESTful의 목적

이해하기 쉽고, 사용하기 쉬운 REST API를 만드는 것을 말한다.

 

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

 

2) RESTful하지 못하는 경우

URI 규칙은 올바르게 지키지 않은 API, REST API 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만, RESTful하지 못한 시스템이라고 할 수 있다.