REST❔
Representational State Transfer의 약자로 다음과 같은 구성으로 이루어져 있다.
자원(RESOURCE) - URI
- 모든 자원에 고유한 ID가 존재하고, 이 자원은 server에 존재한다.
- client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 server에 요청한다.
행위(Verb) - HTTP Method
- HTTP 프로토콜은 GET, POST, PUT DELETE와 같은 메서드를 제공한다.
표현(Represetations)
- client가 자원의 상태에 대한 조작을 요청하면 server는 이에 적절한 응답(representation)을 보낸다.
- REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 representation으로 나타낼 수 있다.
즉, HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)를 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
✔️ CRUD Operation
- Create : 생성(POST)
- Read : 조회(GET)
- Update : 수정(PUT)
- Delete : 삭제(DELETE)
- HEAD : header 정보 조회(HEAD)
특징
-
Uniform(유니폼 인터페이스)
URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍쳐 스타일 -
Stateless(무상태성)
REST는 무상태성 성격을 갖는다. 작업을 위한 상태 정보를 따로 저장하고 관리하지 않으며, 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다.
서비스의 자유도가 높아지고 서버에서 불필여한 정보를 관리하지 않음으로써 구현이 단순해진다. -
Cacheable(캐시 가능)
HTTP 라는 기존 웹 표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용 가능하며 HTTP가 가진 캐싱 기능이 적용 가능하다. -
self-descriptiveness(자체 표현 구조)
REST API 메세지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다. -
client-server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인능이나 컨택스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 칼라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다. -
계층형 구조
다중 계층으로 구성될 수 있으며, 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고, PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있게 한다.
장점
- REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일이다.
- 서버와 클라이언트의 역할을 명확하게 분리한다.
REST API 디자인 가이드
-
리소스명은 동사보다 명사를 사용하며, URI는 정보의 자원을 표현해야 한다.(delete와 같은 행위에 대한 표현이 들어가지 않아야 한다.)
-
자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.
-
슬래시 구분자(/)는 계층 관계를 나타내는데 상요되며 URI 마지막 문자로 슬래시를 포함하지 않는다.
✔️ URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 리소스가 다르면 URI도 달라져야 한다.
REST API는 분명한 URI를 만들어 통신해야 하기 때문에 혼동을 주지 않도록 경로의 마지막에는 슬래시를 사용하지 않는다. -
불가피하게 긴 URI경로를 사용하게 될 경우 하이픈을 사용해 가독성을 높인다.
-
underscore(_)는 URI에 사용하지 않는다.(하이픈으로 대체)
-
대소문자에 따로 다른 리소스로 인식하게 되기 때문에 URI경로에는 소문자가 적합하다.
RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정한다.
-
파일 확장자는 URI에 포함시키지 않는다.(Accept header 사용)
-
직관적인 REST API를 위해 collection과 document 사용시 단수, 복수에 주의한다.(collection: 객체들의 집합, document: 객체)
#sports, players 컬렉션과 soccer, 13 document로 이루어져 있다.
http://restapi.example.com/sports/soccer/players/13- 리소스 간에 연관관계가 있을 시에는 다음고 같이 사용한다.
/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)HTTP Status Code
정확한 응답의 상태 코드만으로도 많은 정보를 전달할 수 있기 때문에 잘 설계된 REST API는 그 리소스에 대한 응답을 잘 보내줘야 한다.
200 클라이언트의 요청을 정상적으로 수행함
201 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨
400 클라이언트의 요청이 부적절 할 경우
401 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때
403 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때
(403 자체가 리소스가 존재한다는 뜻이기 때문에 403 보다는 400이나 404를 사용할 것을 권고한다.)
405 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우
301 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때
(응답 시 Location header에 변경된 URI를 적어 줘야 한다.)
500 서버에 문제가 있을 경우
