1. REST란
“Representational State Transfer” 의 약자로 자원(resource)의 표현(representation) 에 의한 상태 전달 통신 방법론이다.
여기서 자원의 표현이란 그 자원을 표현하기 위한 이름을 의미한다. 예를 들면 DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현이 된다. 여기서 상태(정보) 전달이란 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다는 것을 의미한다. 보통 자원의 상태는 JSON 혹은 XML를 통해 주고 받는 것이 일반적이다. REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.
2. REST의 구체적인 개념
구체적으로 REST란 HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
CRUD Operation이란 Create : 생성(POST), Read : 조회(GET), Update : 수정(PUT), Delete : 삭제(DELETE)를 의미한다.
3. REST의 장단점
3-1. 장점
REST API 메시지가 의도하는 바를 명확하게 나타내므로(자원이 명시되니깐) 의도하는 바를 쉽게 파악할 수 있다.
3-2. 단점
표준이 존재하지 않는다.
사용할 수 있는 메소드가 4가지 밖에 없고 형태가 제한적이다.
4. REST가 필요한 이유
최근의 서버 프로그램은 다양한 브라우저와 모바일 디바이스에서도 통신을 할 수 있어야 한다.
이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, RESTful API를 서비스하기만 하면 어떤 다른 모듈 또는 애플리케이션들이라도 RESTful API를 통해 상호간에 통신을 할 수 있기 때문이다. 또한 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
5. REST 구성 요소
5-1. 자원(Resource): URI(인터넷 자원을 나타내는 고유 식별자)
모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
5-2. 행위(Verb): HTTP Method
HTTP 프로토콜의 Method를 사용한다.
HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.
5-3. 상태(Representation of Resource)
Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
REST에서 하나의 자원은 JSON, XML 등 여러 형태의 Representation으로 나타내어 질 수 있다.
6. REST 특징
6-1. Stateless(무상태)
HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.즉, Client의 context를 Server에 저장하지 않는다. 따라서 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다. Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다. 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
6-2. Cacheable(캐시 처리 가능)
웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능(정적인 컨텐츠를 매번 불러오지 않고 기억해두는 기능)을 적용할 수 있다. 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
6-3. Uniform Interface(인터페이스 일관성)
URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다. 특정 언어나 기술에 종속되지 않는다.
7. REST API 설계 기본 규칙
7-1. URI는 정보의 자원을 표현해야 한다.
7-2. resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
7-3. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
7-4. URI에 HTTP Method가 들어가면 안된다.
Ex) GET /members/delete/1 -> DELETE /members/1
7-5. URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
Ex) GET /members/show/1 -> GET /members/1
Ex) GET /members/insert/2 -> POST /members/2
7-6. 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
Ex) student를 생성하는 route: POST /students
Ex) id=12인 student를 삭제하는 route: DELETE /students/12
8. REST API 설계 규칙
8-1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
Ex) http://restapi.example.com/houses/apartments
8-2. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
8-3. URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
8-4. 하이픈(- )은 URI 가독성을 높이는데 사용
8-5. 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
8-6. 밑줄(_ )은 URI에 사용하지 않는다. 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
8-7. URI 경로에는 소문자가 적합하다.
8- 8. URI 경로에 대문자 사용은 피하도록 한다.
8-9. 파일확장자는 URI에 포함하지 않는다.
8-10. 리소스 간에는 연관 관계가 있는 경우 아래와 같이 작성한다.
/리소스명/리소스 ID/관계가 있는 다른 리소스명
Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
9. RESTful이란
RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.
10. RESTful의 목적
이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것. REST 규칙에 알맞게 잘 짜여졌으면 RESTful하다고 한다.
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.
11. RESTful 하지 못한 경우
Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)
12. 참고
https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html