REST ?
Representational State Transfer의 약자로, 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미합니다. 네트워크상에서 Client와 Server 사이의 통신 방식 중 하나입니다.
HTTP URL(Uniform Resource Identifier)을 통해 자원(Resource)을 명시하고, HTTP 메서드(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 말합니다.
즉, REST 는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP 메서드 통해 Resource를 처리하도록 설계된 아키텍처를 뜻합니다.
REST 구성 요소
자원(Resource) : URL
- 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
- 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URL이다.
- Client는 URL를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
행위(Verb) : HTTP 메서드
주로 사용
- GET : 서버로부터 데이터를 취득, 조회
- POST : 서버에 데이터를 추가, 작성 등
- PUT : 서버의 데이터를 갱신, 수정, 작성 등 (전체를 수정)
- DELETE : 서버의 데이터를 삭제
- PATCH : 리소스의 일부분을 수정
그 외
- HEAD : 서버 리소스의 헤더 (메타 데이터 취득)
- CONNECT : 프록시 동작의 터널 접속을 변경
- OPTIONS : 리소스가 지원하고 있는 메소드의 취득
- TRACE : 대상 리소스의 대한 경로를 따라 메시지 루프백 테스트 수행
표현(Representation of Resource)
- Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
- JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
REST 특징
Server-Client(서버-클라이언트 구조)
자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
- REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
- Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
Stateless(무상태)
- HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.Client의 context를 Server에 저장하지 않는다.
- 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
- Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
- 각 API 서버는 Client의 요청만을 단순 처리한다.
- 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
Cacheable(캐시 처리 기능)
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
- HTTP 프로토콜 표준에서 사용하는 Last-Modified 태스나 E-Tag를 이용하면 캐싱 구현이 가능하다.
- 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
- 캐시 사용을 통해 응답시간이 빨리지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
Layered System(계층화)
- Client는 REST API Server만 호출한다.
- REST Server는 다중 계층으로 구성될 수 있다.
- API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
- 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
- PROXY, 게이트웨어 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
Code-On-Demand(optional)
- Server로부터 스크립트를 받아서 Client에서 실행한다.
- 반드시 충족할 필요는 없다.
Uniform Interface(인터페이스 일관성)
- URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- 특정 언어나 기술에 종속되지 않는다.
API ?
먼저, 사용자가 명령을 넣는 것 뿐 아니라 그 결과와 정보들을 받아오기 위한 제어 장치인 TV의 스크린, 컴퓨터의 모니터를 인터페이스 라고 합니다.
소프트웨어가 다른 소프트웨어로부터 지정된 형식으로 요청, 명령을 받을 수 있는 수단을 Application Programming Interface의 약자, API 라고 합니다. 즉, 클라이언트가 리소스를 요청할 수 있도록 서버측에서 제공된 인터페이스(interface)를 말합니다.
서버를 개발한다는 것은 API에 대한 마스터 권한이 생기는 것이다.
REST API ?
REST API (RESTful, Representational State Transfer) 는 REST 기반으로 서비스 API를 구현하는 것을 말합니다.
정보들이 주고받아지는 데 있어서 개발자들 사이에 널리 쓰이는 일종의 형식으로, HTTP기반으로 필요한 리소스를 요청하는 아키텍처로 설계된 어플리케이션 프로그래밍 인터페이스입니다.
REST의 가장 중요한 특성은 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청을 보내는 주소만으로 대략 어떤 것을 요청하는 것인지 추론이 가능해 프론트엔드와 백엔드 사이 통신을 가능하게 하는 것입니다.
서버에 REST API로 요청을 보낼 때는 HTTP란 규약에 따라 신호를 전송합니다.
REST API 설계 기본 규칙
참고 리소스 원형
도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소
1. URL는 정보를 자원을 표현해야 한다.
- resource는 동사보다는 명사를, 대문자 보다는 소문자를 사용한다.
- resource의 도큐먼트 이름으로는 단수 명사를 사용해야한다.
- resource의 컬렉션 이름으로는 복수 명사를 사용해야한다.
- resource의 스토어 이름으로는 복수 명사를 사용해야한다.
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
- URL에 HTTP Method가 들어가면 안된다.
- Ex)
GET /Member/1→GET /members/1
- URL에 행위에 대한 동사 표현이 들어가면 안된다. (즉, CRUD 기능을 나타내는 것은 URL에 사용하지 않는다.)
- 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 설계 규칙
1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
Ex) http://restapi.example.com/houses/apertments
2. URL 마지막 문자로 슬래시(/ )를 포함하지 않는다.
- URL에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며,
URL가 다르다는 것은 리소스가 다르다는 것이고,역으로 리소스가 다르면 URL도 달라져야한다. - REST API는 분명한 URL를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URL 경로의 마지막에는 슬래시(/ )를 사용하지 않는다.
3. 하이픈(- )은 URL 가독성을 높이는데 사용한다.
불가피하게 긴 URL경로를 사용하게 된다면 하이픈을 사용해 가독성을 높여준다.
4. 밑줄(_ )은 URL에 사용하지 않는다.
밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
5. URL 경로에는 소문자가 적합하다.
URL 경로에 대문자 사용은 피하도록 한다.
PFC 3986(URL 문법 형식)은 URL 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.
6. 파일확장자는 URL에 포함하지 않는다.
REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URL안에 포함시키지 않는다.
Accep header를 사용한다.
- Ex)
http://restapi.example.com/members/soccer/345/photo.jpg(X) - Ex)
GET /members/soccer/345/photo HTTP/1.1Host: restapi.example.com Accept: image/jpg(O)
7. 리소스 간에는 연관 관계가 있는경우
/리소스명/리소스 ID/관계가 있는 다른 리소스명
Ex) GET : /users/{userid}/devices (일반적으로 소유 'has'의 관계를 표현할 때)
RESTful
RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어입니다. ‘REST API’ 원리를 따르는 웹 서비스를 ‘RESTful’하다고 할 수 있습니다.
RESTful의 목적
이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 목표입니다.
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기입니다.
RESTful 하지 못한 경우
- Ex1) CRUD 기능을 모두 POST로만 처리하는 API
- Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)
