Search

REST와 REST API, RESTful API

생성일
2023/09/10 05:24
태그
spring
web service
상태
Done

REST란

REST란 Representational State Transfer의 약자로, 자원의 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미한다.
자원 : 해당 소프트웨어가 관리하는 모든것(문서, 그림, 데이터 등)
표현 : 그 자원을 표현하기 위한 이름(학생 정보 - student, 게시글 - board 등)
상태 전달 : 데이터가 요청되는 시점의 자원의 상태 전달(JSON이나 XML으로)
REST의 개념은 어떤 자원에 대해 CRUD(Create, Read, Update, Delete) 연산을 수행하기 위해 URI(Resource)로 GET, POST 등의 방식(Method)을 통해 요청을 보내는 것이다. 요청과 응답에 대한 자원은 특정한 형태(Representation of Resource)로 표현된다.
REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나로, 기본적으로 기존에 웹에서 사용되는 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처다.

REST 구성요소

1.
자원(Resource) - URI
자원마다 고유한 ID가 존재하고, 해당 자원은 Server에 존재한다.
모든 자원을 구별하는 ID는 ‘/exgroups/:exgroup_id’와 같은 형태의 HTTP URL이다.
Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태에 대한 조작을 Server에 요청한다.
2.
행위(Verb) - Method
HTTP 프로토콜의 Method를 사용한다.
GET, POST, PUT, PATCH, DELET의 Method가 있다.
3.
표현(Representation of Resource)
Client가 Server와 자원을 주고받는 형태로 JSON, XML, text, RSS 등이 있다.

REST 특징

1.
Server-Client 구조
자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
REST Server는 API를 제공 및 비즈니스 로직 처리, 저장을 책임진다.
Client는 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
Server-Client 역할을 구분함으로써 상호 간의 의존성을 줄인다.
2.
Stateless
HTTP 프로토콜이 Stateless 프로토콜이므로, REST 역시 Stateless 특성을 가진다.
Client의 context(세션, 쿠키)를 Server에 저장하지 않고, 그로 인해 구현이 단순해진다.
Server는 각각의 요청을 독립적으로 인식하고 처리하여, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.(DB에 의한 데이터 변화 제외) 이로 인해 서비스의 자유도가 높아진다.
3.
Cacheable
HTTP 프로토콜을 그대로 사용하므로, HTTP의 가장 강력한 특징인 캐싱 기능을 적용할 수 있다.
Last-Modified Tag 혹은 E-Tag를 통해 캐싱을 구현하고, 대량의 요청을 효율적으로 처리할 수 있다.
4.
Layered System
REST Server는 다중 계층으로 구성될 수 있다.
보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하거나, Proxy, Gateway와 같은 네트워크 기반의 중간매체를 사용할 수 있다.
Client는 Server와 직접 통신하는지, 중간 서버와 통신하는지 알 수 없다.
5.
Uniform Interface
URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
특정 언어나 기술에 종속되지 않고, HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용이 가능하다.
6.
Self-Descriptiveness
요청 메세지만 보고도 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.

REST API

REST API란 REST의 특징을 기반으로 서비스 API를 구현한 것을 의미하며, OpenAPI(누구나 사용할 수 있도록 공개된 API)나 마이크로 서비스 등을 제공하는 기업 대부분은 REST API를 제공한다.
마이크로 서비스 하나의 큰 어플리케이션을 여러 작은 어플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처
REST API의 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지를 요청 그 자체로 추론이 가능하다는 것이다.

REST API 설계 규칙

REST API를 설계할 때 가장 중요한 것은 URI가 자원을 표현해야한다는 것과, 자원에 대한 행위를 HTTP Method로 표현하는 것이다.
1.
URI는 명사를 사용한다.(get, update 등의 동사를 사용하면 안된다)
2.
슬래시(/)로 계층 관계를 표현한다.
3.
URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
4.
언더바(_)를 사용하지 않고, 하이픈(-)을 사용한다.
5.
URI는 소문자로만 구성한다.
6.
요청에 대한 실패나 처리완료에 대한 피드백으로, HTTP 응답 상태 코드를 사용한다.
7.
파일 확장자는 URI에 포함하지 않는다.

RESTful API

RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 말하며, REST를 REST답게 사용하기 위한 방법을 뜻한다. 즉, REST 원리를 따르는 시스템은 RESTful하다고 할 수 있다.
CRUD 기능을 모두 POST로만 처리하는 API나, URI에 updateName과 같이 Resource 외의 정보나 동사가 포함되는 경우 RESTful 하지 못하다고 표현할 수 있다.
RESTful의 목적은 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것으로, 성능 향상이 아니라 일관적인 컨벤션을 통한 API 이해도 및 호환성을 높이는 것이 목적이다.

Spring에서의 REST API

@RequestBody
요청(request)의 본문(body)에 포함된 JSON 형태의 데이터를 자바 객체로 변환하여 Java 애플리케이션에서 가공에 용이하도록 한다.
@ResponseBody
Java 애플리케이션의 자바 객체를 JSON 형태의 데이터로 변환하여 응답(response)의 본문(body)에 첨부한다.
@RestController 어노테이션
@RestController 어노테이션은 @Controller 어노테이션과 @ResponseBody 어노테이션을 포함한 어노테이션이다.

참고