아래에서 상세히 설명이 될 것이지만 REST라는 개념은 더 나은 Web이 되기 위한 일종의 가이드 라인이라고 볼 수 있다. Restful API 는 명확한 표준을 제시하지 않고 있기 때문에 확정된 답은 없고 상황에 맞는 제약에 따를 방법을 찾아가야 하지만 기본적인 틀은 존재하기 때문에 익혀둘 필요가 있다.
(“Representational State Transfer” 의 약자)
자원(resource)을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.
즉, 자원(resource)를 이름으로 구분하여 정보(상태)를 주고 받는 모든 것이다.
월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식
REST의 구체적인 개념
HTTP URI를 통해 자원(Resource)을 명시하고, HTTP Method 를 통해 해당 자원에 대한 CRUD를 적용하는 것을 의미한다.
CRUD Operation
Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
CRUD Operation은 위 4가지 데이터 처리 기능을 묶어서 일컫는 말이다.
HEAD: header 정보 조회(HEAD)
장점
단점
1. 자원(Resource): URI
- 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
- 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
- Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
2. 행위(Verb): HTTP Method
- HTTP 프로토콜의 Method를 사용한다.
- HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.
3. 표현(Representation of Resource) 또는 행위의 내용
- Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답-(Representation)을 보낸다.
- REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
- JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
1. Server-Client(서버-클라이언트 구조)
서비스가 수행되길 기대하는 클라이언트 구성 요소는 연결자를 통해 서버에 요청을 보내며, 서버는 해당 요청을 거절하거나 수행하고 클라이언트에 응답을 보낸다. 그리고 모든 통신은 클라이언트- 서버간 일대일로 연결된다
자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
서로 간 의존성이 줄어든다.
이러한 분리를 통해 Server-Client의 의존성을 줄이고 각각의 기능에 집중할 수 있다.
2. Stateless(무상태)
각각의 요청 시에 클라이언트의 컨텍스트가 서버에 저장되지 않는다. 그렇기 때문에 위에서 자기 서술형 메시지가 지켜져야 한다. 이 조건을 지킨 서버는 요청에 대한 처리만 하면 되기 때문에 구현이 단순해 진다. 또한 URI에 해당 내용을 포함시키지 않음으로써 Caching 사용 법위가 넓어질 수 있다.
HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
Client의 context를 Server에 저장하지 않는다.
Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
각 API 서버는 Client의 요청만을 단순 처리한다.
3. Cacheable(캐시 처리 가능)
4. Layered System(계층화)
즉, 서버는 클라이언트가 모르게 API 서버에 여러 계층을 추가하여 유연한 구조로 개발될 수 있다.
5. Code-On-Demand(optional)
클라이언트는 리소스에 대한 표현을 응답으로 받고 처리해야 하는데, 어떻게 처리해야 하는지에 대한 Code를 서버가 제공하는 것을 의미한다.
6.Uniform Interface(인터페이스 일관성)
웹에 바람직한 구조적 특성을 부여하는 규칙이며, 리소스 식별, 표현을 통한 리소스 조작, 자기 서술 메시지, 애플리케이션 상태의 엕진으로서의 하이퍼 미디어로 구성되어 있다.
URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
REST API의 특징
참고 리소스 원형
도큐먼트 ( Document ) : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 ( Collection ): 서버에서 관리하는 디렉터리라는 리소스
스토어 ( Store ): 클라이언트에서 관리하는 리소스 저장소
1. URI는 정보의 자원을 표현해야 한다.
- resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
- resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
- resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
- resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
Ex) GET /Member/1 -> GET /members/1
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
- URI에 HTTP Method가 들어가면 안된다.
Ex) GET /members/delete/1 -> DELETE /members/1- URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
Ex) GET /members/show/1 -> GET /members/1
Ex) GET /members/insert/2 -> POST /members/2- 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
Ex) student를 생성하는 route: POST /students
Ex) id=12인 student를 삭제하는 route: DELETE /students/12
REST API 설계 예시
참고 응답상태코드
1xx : 전송 프로토콜 수준의 정보 교환
2xx : 클라어인트 요청이 성공적으로 수행됨
3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx : 클라이언트의 잘못된 요청, 비정상 처리의 대한 실패
5xx : 서버쪽 오류로 인한 상태코드
RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다. 하지만 누군가 공식적으로 발표한 것은 아니다.
즉, REST 원리를 따르는 웹서비스는 RESTful이란 용어로 지칭한다.
References (참고 자료)
- https://www.slipp.net/wiki/pages/viewpage.action?pageId=12878219
- https://www.a-mean-blog.com/ko/blog/%ED%86%A0%EB%A7%89%EA%B8%80/_/REST%EC%99%80-RESTful-API
- http://mygumi.tistory.com/55
- https://brainbackdoor.tistory.com/53
- http://tech.devgear.co.kr/delphi_news/433404
- https://meetup.toast.com/posts/92
- https://spoqa.github.io/2012/02/27/rest-introduction.html
- https://hackernoon.com/build-restful-api-in-go-and-mongodb-5e7f2ec4be94
- https://docs.oracle.com/cd/E76467_01/alloc/pdf/141/html/operations_guide/alloc-og_restful-impl.htm
- https://blog.naver.com/PostView.nhn?isHttpsRedirect=true&blogId=hoyeon0&logNo=50137172782
- https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html