23.12.21 REST, REST API, RESTful 이란?

CS 전공지식

23.12.21 REST, REST API, RESTful 이란?

김용글 2023. 12. 21. 13:29

1. REST (Representational State Transfer)

1) 정의

- HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,

HTTP Method(POST, GET, PUT, DELETE)를 통해 자원에 대한 CRUD Operation 을 적용하는 것

- 즉 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource 가 있고 HTTP Method 를

통해 Resource 를 처리하도록 설계된 아키텍쳐

- 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID 인 HTTP URL을 부여한다.

- CRUD Operation

(1) Create : 생성 (POST)

(2) Read : 조회 (GET)

(3) Update : 수정 (PUT, PATCH)

(4) Dlete : 삭제 (DELETE)

(5) HEAD : header 정보 조회 (HEAD)

- 자원(resource)의 표현(representation)에 의한 상태 전달

(1) 자원(resource)의 표현(representation)

- 자원 : 해당 소프트웨어가 관리하는 모든것

예) 문서, 그림, 데이터, 해당 소프트웨어 자체 등

- 자원의 표현 : 그 자원을 표현하기 위한 이름

예) DB 의 학생 정보가 자원 일때 students 를 자원의 표현으로 정함

(2) 상태(정보) 전달

- 데이터가 요청되어 지는 시점에서 자원의 상태(정보)를 전달

- JSON 혹은 XML 를 통해 데이터를 주고 받는 것이 일반적

2) 장점

- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능

- REST API 메시지가 의도하는 바를 명확하게 나타내므로 쉽게 파악할 수 있다

- HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다

- HTTP 프로토콜의 표준을 최대한 활용하여 추가적인 장점을 함께 가져갈 수 있게 해준다

- Hypermedia API 의 기본을 충실히 지키면서 범용성 보장

- 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화

- 서버와 클라이언트의 역활을 명확하게 분리

3) 단점

- 표준이 존재하지 않는다

- HTTP Method 형태가 제한적

- 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URI 보다 Header 값을 처리해야 하므로

전문성이 요구됨

4) 구성 요소

(1) 자원(Resource) : URI

- 모든 자원에 고유한 ID 가 존재하고, 이 자원은 Server 에 존재

- 자원을 구별하는 ID 는 '/groups/:prout_id 와 같은 HTTP URL

- Client 는 URI을 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server 에 요청

(2) 행위(Verb) : HTTP Method

- HTTP 프르토콜의 Method 를 사용

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

(3) 표현(Representation of Resource)

- Client 가 자원의 상태(정보)에 대한 조작을 요청하면 Server 는 이에 적절한 응답을 보냄

- REST 에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation 으로 나타내어 질 수 있다

- JSON 혹은 XML 을 통해 데이터를 주고 받는 것이 일반적

5) 특징

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

- 자원이 있는 쪽이 Server, 요청하는 쪽이 Clinet 가 됨

- REST Server : API 를 제공하고 비지니스 로직 처리 및 저장을 책임 짐

- Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임 짐

- 서로 간 의존성이 줄어듬

(2) Stateless (무상태) : Server 가 Clinet 의 상태를 보존하지 않는 것

- HTTP 프로토콜은 Stateless Protocol 이므로 REST 역시 무상태성을 같는다

- Client 의 context 를 Server 에 저장하지 않는다 즉, 세션과 쿠키같은 context 정보를 신경 쓰지 않아도 되므로

구현이 단순해짐

- Server 는 각각의 요청을 완전히 별개의 것으로 인식하고 처리 함

A) 각 API 서버는 Client 의 요청만을 단순 처리

B) 이전요청이 다음 요청의 처리에 연관되어서는 안됨

C) 물론 이전 요청이 DB 를 수정하여 DB 에 의해 바뀌는 것은 허용

D) Server 의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아짐

(3) Cacheable (캐시처리기능)

- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 사용 할 수 있다

A) HTTP 가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.

B) HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag 를 이용하면 캐싱 구현이 가능

- 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구됨

- 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능,

서버의 자원 이용률을 향상 시킬 수 있다.

(4) Layered System (계층화)

- Client 는 REST API Server 만 호출

- REST Server 는 다중 계층으로 구성 될 수 있다

A) 순수 비지니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의

유연성을 줄 수 있다.

B) 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.

- PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

(5) Code-On-Demane (optional)

- Server 로 부터 스크립트를 받아서 Client 에서 실행

- 반드시 충족할 필요 없다

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

- URI 로 지정한 Resource 에 대한 조작을 통일되로 한정적인 인터페이스로 수행

- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능

- 특정 언어나 기술에 종속되지 않음

2. REST API

1) 정의

- REST 기반으로 서비스 API 를 구현한 것

- 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API : 구글맵, 공공 데이터등), 마이크로서비스

(하나의 큰 애플리케이션을 여러개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처)

등을 제공하는 업체 대부분은 REST API 제공

2) API(Application Programming Interface) 란

- 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환 가능하도록 하는 것

3) 특징

- 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 운용을 편리하게 할 수 있다

- REST 는 HTTP 표준을 기반으로 구현하므로 HTTP 를 지원하는 프로그램 언어로 클라이언트, 서버를 구현

할 수 있다.

- REST API 를 제작하면 델파이 클라이언트 뿐 아니라 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

4) 설계 규칙

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

- 나쁜 예 : http://khj93.com/Running/

- 좋은 예 : http://khj93.com/run

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

- 나쁜 예 : http://khj93.com/test/

- 좋은 예 : http://khj93.com/test

(3) 언더바 대신 사이폰을 사용

- 나쁜 예 : http://khj93.com/test_blog

- 좋은 예 : http://khj93.com/test-blog

(4) 파일 확장자는 URI 에 포함하지 않음

- 나쁜 예 : http://khj93.com/photo.jpg

- 좋은 예 : http://khj93.com/photo

(5) 행위를 포함하지 않음

- 나쁜 예 : http://khj93.com/delete-post/1

- 좋은 예 : http://khj93.com/post/1

3. RESTful

1) 정의

- REST 원리를 따르는 시스템

- REST API 의 설계 규칙을 올바르게 지킨 시스템

2) 목적

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

- 일관적인 컨벤션을 통한 API 의 이해도 및 호환성을 높이는 것이 주 동기

- RESTful 하지 못한 경우

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

(2) route 에 resource, id 외의 정보가 들어가는 경우 (/students/updateName)