REST란? REST API,RESTful 에 대하여.

이전 회사에서 일할 때, REST API에서 웹 앱에서 각자 필요한 정보들이 생기면, 만들어둔 해당 URI로 요청 시 필요한 리소스들을 내려주는 서버라고 간단하게만 생각하고 있었다. 이번 기회에 좀 자세히 알고 싶어 이곳저곳 검색과 영상 등을 보며 정리를 해보려고 한다.
REST의 기본 개념 및 규칙 등을 알아보자.

우선 REST란?

위에 보이는 REST의 약자 Representational State Transfer의 약자이다.
자원의 이름, 표현으로 구분하여 해당 자원의 정보를 주고받는 모든 것들을 의미한다.
자원(resource)의 표현(Representational)에 의한 상태 전달.
자원의 표현이라 할 수 있다.

- 자원

자원이라고 하면, 해당 소프트웨어가 관리하는 모든 것이 될 수 있으며,
어떠한 document, data, img 등으로 예를 들 수 있다.

- 자원의 표현 , 상태 전달

해당 자원을 표현하기 위한 이름이라고 할 수 있으며, 데이터베이스(Data Base)에서 사원 정보가 자원이라고 예를 들면,
'employee'가 자원의 표현으로 정하는 것이다.
이것에 대한 정보를 전달하는데 데이터가 요청되는 시점에서 자원의 상태(정보)를 전달하고, JSON 혹 XML을 통하여 데이터를 주고받는 것이 일반적이다.

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

REST의 구체적인 의미

HTTP URI(Uniform Resorce Identifier)를 통해 자원(Resorce)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통하여 해당하는 자원에 대한 CRUD 조작을 적용하는 것을 의미한다.
REST는 자원 기반의 구조(ROA, Resorce Oriented Architecture) 설계의 중심에 Resorce가 있고 , HTTP Method를 통하여 자원을 처리하도록 설계된 아키텍처를 의미한다.
웹 사이트의 텍스트, 이미지, DB의 data 등 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

CRUD Operation
CREATE : 생성 (POST)
READ : 조회 (GET)
UPDATE : 수정(PUT)
DELETE : 삭제(DELETE)
HEAD : header 정보 조회(HEAD)

REST 구성 요소

자원 (Resource) : URI

모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재.
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

행위(Verb) : HTTP Method

HTTP 프로토콜의 Method를 사용한다.
HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다.

자원의 표현(Respresentation of Resource)

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

REST 특징

서버 - 클라이언트 구조

서버와 클라이언트 구조로 되어 있으며,
자원을 가지고 있는 쪽이 Server가 되고, 자원을 요청하는 쪽이 Client가 된다.
REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 담당.
Client : 사용자 인증 context(세션, 로그인 정보)등을 담당한다.
서로 간 의존성이 줄어듬.

Stateless(무상태)

HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상 태성을 갖는다.
Client의 context를 Server에 저장하지 않는다.
즉, 세션 쿠키와 같은 context 정보를 신경 쓰지 않아도 되므로 구현이 단순해진다.
Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
각 API 서버는 Client의 요청만을 단순 처리한다, 이것에 의미는 이전 요청이 다음 요청의 처리에 연관되어서는 안 됨을 의미한다. 하지만 이전 요청이 DB 데이터를 수정한 작업이라면 DB에 의하여 정보가 바뀌는 것은 허용이 된다.
Server의 처리 방식에 일관성을 부여함으로 부담이 줄어들고, 서비스의 자유도가 높아진다.

Cacheable(캐시 처리 가능)

웹 표준 HTTP 프로토콜은 그대로 사용하므로, 웹에서 사용하는 기존의 인프라를 그대로 활용 가능하며
이것에 대한 의미는 HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
HTTP 프로토콜 표준에서 사용하는 Last-Modfied 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
대량의 요청을 효율적으로 처리하기 위하여 캐시가 요구된다.
캐시 사용을 통하여 응답 시간이 빨라지고 REST Server의 트랜잭션이 발생하지 않기 때문에, 전체 응답 시간 및 성능 서버의 자원 이용률을 향상할 수 있음을 의미한다.

Layered System(계층화)

REST Server는 다중 계층으로 구성될 수 있다.
API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연함을 가지게 할 수 있다.
로드밸런싱, 공유 캐시 등을 통하여 확장성과 보안성을 향상할 수 있다.
PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

Code-On-Demand(optional)

Server로부터 스크립트를 받아서 Client에서 실행하는 것을 의미하며, 이것에 대한 기능을 반드시 충족할 필요는 없다.

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

HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능하며, 이것에 의미는 특정 언어 기술에 종속되지 않음을 의미한다.
URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행.

REST API의 개념 (Representational State Transfer API)

API (Application Programing Interface) : 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램 간 상호작용을 촉진하며, 서로 정보 교환을 가능하도록 하는 것이다.

REST API의 정의

REST 기반으로 서비스 API를 구현한 것
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API : 구글 맵, 코인 거래소, Riot Open API, 공공데이터), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처)등을 제공하는 업체 대부분은 REST API를 제공한다.
REST API의 특징
사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있음.
REST API를 제작하면 델파이 클라이언트뿐 아니라, 자바 , C# 등 다양한 언어를 이용하여 클라이언트를 제작할 수 있음.

REST API 설계 규칙들

document : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
collection : 서버에서 관리하는 디렉터리라는 리소스
store : 클라이언트에서 관리하는 리소스 저장소

1. URI의 정보는 자원을 표현해야 함.
resource는 동사보다는 명사를, 대문자보다는 소문자를 사용.
resoucre의 도큐먼트 이름으로는 단수 명사를 사용해야 함.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 함.
resource의 스토어 이름으로는 복수 명사를 사용해야 함.

request mapping : GET /Student/1 X

request mapping : GET /students/1 O

2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현함.
URI에 HTTP Method가 들어가면 안 됨.

request mapping : POST/students/delete/1 X

request mapping : DELETE /students/1 O

3. URI에 행위에 대한 동사 표현이 들어가면 안 된다.(CRUD 기능을 나타내는 것은 URI에 사용하지 않음)

reqeust mapping : GET /students/show/1 X	request mapping : GET /students/1 O
reqeust mapping : GET /students/insert/1 X	request mapping : POST /students/1 O

경로 부분 중 변하는 부분은 유일한 값으로 대체한다 - id는 특정 resource를 나타내는 고윳값

student를 생성하는 request mapping : POST /students

id값이 1인 student 삭제 request mapping : DELETE /students/1

슬래시(/) 구분자는 계층 관계를 나타낼 때 사용.
- http://testapi.com/human/adult/man
URI 마지막 문자로 슬래시(/) 포함하지 않음
URI에 포함되는 글자는 리소스의 유일한 식별자로 사용되어야 하며, URI가 다르다는 것은 리소스가 다른 것이고, 역으로 리소스가 다르다면 URI도 달라져야 한다.
REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI경로에 마지막에는 /를 넣지 않는다.
- http://testapi.com/human/adult/man/

하이픈(-)은 URI 가독성을 높이는 데에 사용, 언더바(_)는 URI에 사용하지 않음. 언더바 대신 하이픈을 결국 사용
불가피하게 경로가 길다면 URI경로를 사용하여 하이픈을 이용하여 가독성을 높임.
글꼴에 따라 다르긴 하다고 하나 언더바는 띄지 않거나, 문자가 가려지기도 한다.
이러한 문제를 피하기 위해 언더 바대 신 하이픈을 사용한다.

URI 경로에는 소문자가 적합.
URI 경로에 대문자 사용은 피하도록 해야 한다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다.
RFC3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.

파일 확장자는 URI에 포함시키지 않는다.
http://testapi.com/students/grade/6/data.txt

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
GET / students/grade/6/photo HTTP/1.1 Host: testapi.com Accept:txt

- REST API 사용 이유 , 필요한 이유

회사에서 현재 백엔드 개발자, 앱 개발자 등을 따로 두고 있는데, IOS AOS 등에서 쓰이는 언어가 다르다, 그렇다고 해서 같은 서비스를 각각 자기 환경에서 연결하여 쓰는 것은 낭비라고 볼 수 있다.
그리하여 필요한 정보들을 한데 모아두어 요청하여 다들 각자 환경에 맞게끔 표현만 하되 해당 정보들은 REST API가 구축되어있는 곳에 요청하여 받아 사용하면 되는 것이다.
최근 서버 프로그램은 다양한 브라우저와 안드로이드, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 하며,
멀티 플랫폼에 대한 지원을 위하여, 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다

RESTful 이란?

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹서비스를 나타내기 위해 사용되는 용어.
REST API를 제공하는 웹 서비스를 RESTful 하다고 할 수 있다.
RESTful은 REST를 REST 답게 쓰기 위한 방법으로 누군가가 공식적으로 발표한 것은 아니다.
즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.
이해하기 쉽고, 사용하기 쉬운 REST API를 만드는 것
RESTful 한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라, 일관성 있게 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESULTful 한 API를 구현할 이유는 없다.
REST를 REST 답게 쓰자, 취지에 비공식적으로 개발자들이 의견을 제시한 것이라, 명확한 정의는 없다고 함.

- RESTful 하지 못한 경우
CRUD의 기능을 전부 하나의 HTTP METHOD로만 처리한 경우.
URI에 자원과 id 외 정보가 들어가는 경우.


HTTP 응답 코드.

2xx

200 : 클라이언트의 요청을 정상적으로 수행함을 의미.

201 : 클라이언트에게 생성 작업을 요청 받았고, 생성 작업을 성공함을 의미.

204 : 요청은 성공 했지만 응답할 콘텐츠가 없음.

3xx 리다이렉션

301 : 클라이언트가 요청한 리소스에 대한 URI가 영구적으로 변경되었을 때 사용함.

302 : 301과 같으나 임시적으로 주소가 바뀌었을 경우 사용함.

304 : 이전에 방문했을 때의 요청 결과와 다르지 않을 경우 사용함. 캐시 된 페이지를 그대로 사용.

307 : 임시 페이지로 리다이렉트.

4xx 클라이언트 오류

400 : 클라이언트가 올바르지 못한 요청을 보냄.

401 : 로그인을 하지 않아 페이지를 열 권한이 없음.

403 : 금지된 페이지, 로그인을 하든 안 하든 접근할 수 없음. (관리자 페이지)

404 : 찾을 수 없는 페이지, 주소를 잘 못 입력했을 때 사용함. -> 403대신에 404를 사용 하기도 함 (위장페이지)

408 : 요청 시간이 초과

409 : 서버가 요청을 처리하는 과정에서 충돌이 발생한 경우. (회원가입 중 중복된 아이디인 경우)

410 : 영구적으로 사용할 수 없는 페이지.

5xx 서버 오류

501 : 해당 요청을 처리하는 기능이 만들어지지 않음.

502 : 서버로 가능 요청이 중간에서 유실된 경우.

503 : 서버가 터졌거나(서버 과부하) 유지 보수 중(유지 보수 중일때는 유지 보수중이라는 것을 알려주는 페이지로 전송해주는 것이 좋음)

504 : 서버 게이트웨이에 문제가 생겨 시간 초과가 된 경우.

505 : HTTP 버전이 달라 요청이 처리할 수 없음.