REST, REST API, RESTful란?

REST API란?

REST란?

Representational State Transfer 로, 자원을 이름으로 구분하여 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.

즉 자원의 표현에 의한 상태 전달이라는 뜻으로, URI는 하나의 고유한 리소스 대표하도록 설계된다는 개념이다. (list/123 : 123번째 리스트 항목처럼 고유하 의미르 가지도록 설계)

그렇다면 자원은 뭐고, 표현, 상태는 무엇이라 말인가?

자원 : 해당 소프트웨어가 관리하는 모든 것 (문서, 이미지, 데이터, 소프트웨어 자체 등등)
표현 : 자원을 표현하기 위한 이름 (학생 정보가 자원일때, “students”로 표현할 수 있다.)
상태 : 데이터가 요청되는 시점에서의 자원의 상태를 의미한다. 보통 JSON, XML을 통해 주고 받는 게 일반적이다.

REST는 www(World wide web)과 밭은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식이다. 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다. 네트워크 상에서 client와 server 사이의 통신 방식 중 하나다.

구체적인 개념을 보면 다음과 같다.

HTTP URI(Uniform Resource Identifier)를 통해 자원을 명시하고, HTTP method(POST, GET, PUT, DELTE)를 통해 자원에 대한 CRUD Operation을 적용하는 것이다. 쉽게 얘기해서 http method를 통해 자원을 처리하도록 설계된 아키텍처를 의미한다.

Uniform Resource Identifier라는 말에서 알 수 있듯이 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

CRUD Operation

Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD : header 정보 조회(HEAD)

REST의 장단점

장점
- HTTP 프로토콜의 인프라를 그대로 사용하기 때문에 REST API 사용을 위해 별도의 인프라를 구축할 필요가 없다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- REST API 메세지가 의도하는 바를 명확하게 나타내므로 쉽게 의도를 파악할 수 있다.
- 서버와 클라이언트의 역할을 명확하게 분리한다.
단점
- 표준이 존재하지 않는다.
- 사용할 수 있는 메소드가 4가지 밖에 없다.
- 구형 브라우저가 지원하지 못하는 부분이 있다.

필요성

다양한 클라이언트의 등장과 함께 최근 서버 프로그램은 다양한 브라우저와 모바일 디바이스에서도 통신을 할 수 있어야 한다. 멀티 플랫폼에 대한 지원을 위해 REST에 관심을 갖게 되었다.
웹의 장점을 최대한 활용할 수 있다.

구성요소

자원(Resource) : URI
- 모든 자원에는 고유한 ID가 존재하고, 자원은 Server에 존재한다.
- 자원을 구별하는 ID는 HTTP URI이다. (/list/14)
- Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태를 조작하는 것을 server에 요청한다.
행위(Verb) : HTTP Method
- HTTP 프로토콜 Method(GET, POST, PUT, DELETE)를 사용한다.
표현(Representation of Resource)
- Client가 자원의 상태에 대한 조작을 요청하면 server는 적절한 응답(representaion)을 보낸다. 이때 JSON/XML을 통해 데이터를 주고 받는게 일반적이다.

특징

Server-Client(서버-클라이언트 구조)
- 자원이 있는 쪽이 server, 요청하는 쪽이 client다.
- 서버는 API를 제공하고 비즈니 로직 처리 및 저장을 책임진다.
- 클라이언트는 사용자 인증, context(세션, 로그인 정보)를 직접 관리하고 책임진다.
- 서버-클라이언트간의 의존성이 줄어든다.
Stateless(무상태)
- HTTP 프로토콜은 stateless protocol이므로 rest 역시 무상태성을 갖는다.
- client의 context를 server에 저장하지 않는다. 이러 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
- Server는 각 요청을 완전히 별개의 것으로 인식하고 처리한다. 이전 요청이 다음 요청의 처리에 관여해선 안된다. Server의 처리 방식에 일관성을 부여하고 부담이 줄어들기 때문에 서비스의 자유도가 높아진다.
Cacheable(캐시 처리 가능)
- HTTP 프로토콜을 그대로 사용하므로 HTTP가 가진 특징 중 하나인 캐싱 기능을 적용할 수 있다.
- 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
- 캐시를 사용함으로써 응답시간이 빨라지고 성능, 서버의 자원 이용률을 향상시킬 수 있다.
Layered System(계층화)
- Client는 REST API Server만 호출한다.
- REST Server는 다중 계층으로 구성될 수 있다.
- API Server는 순수 비즈니스 로직을 수행하고 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증을 추가해 구조상 유연성을 줄 수 있다.
Code-On-Demand(optional)
- server에서 스크립트를 받아 client에서 실행한다.
Uniform Interface(인터페이스 일관성)
- URI로 지정한 Resource에 대한 조작을 통일하고 한정적인 인터페이스로 수행한다.

REST API란

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

REST API는 REST 기반으로 서비스 API를 구현한 것이다.

URI는 정보의 자원을 표현해야 한다. (자원 명은 동사보다는 명사를 사용한다.)
자원에 대한 행위는 HTTP Method로 표현한다. (URI에 HTTP Method가 들어가면 안된다.)

예를 들어, GET /members/delete/1 은 DELETE /members/1로 바꿔야 한다.

추가적인 규칙은 다음과 같다.

슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
URI 마지막 문자로 슬래시를 포함하지 않는다. URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며, URI가 다르다는 것은 리소스가 다르다는 것을 의미한다.
하이폰(-)은 URI 가독성을 높이는데 사용한다.
밑줄(_)은 URI에 사용하지 않는다. 밑줄은 보기 힘들고, 밑줄때문에 문자가 가려지기도 한다.
URI 경로에는 소문자가 적합하다.
파일 확장자는 URI에 포함하지 않는다.

HTTP 응답 상태 코드

잘 설계된 REST API는 URI만 잘 설계된 것이 아니라 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다.

200대

상태코드
200	클라이언트의 요청을 정상적으로 수행함
201	클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통해 리소스 생성 작업을 했을 때)

400대

상태코드
400	클라이언트의 요청이 부적절할 경우
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때(로그인 하지 않은 유저가 로그인 했을 때만 요청가능한 리소스를 요청했을 때)
403	유저 인증상태와 관계없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때(403보다는 400, 404를 사용하는 것이 좋다. 403 자체가 리소스가 존재한다는 의미를 나타내기 때문이다.)
405	클라이언트가 요청한 리소스에는 사용 불가능한 method를 이용했을 경우

300, 500

상태코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경되었을 때 사용
500	서버에 문제가 있을 경우

RESTful

RESTful은 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용한다. 즉 REST API를 제공하는 웹 서비스를 RESTful 하다고 할 수 있다.

목적

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

출처 https://meetup.toast.com/posts/92 https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html