1. REST API란?
1 - 1) REST API의 탄생
REST는 Representational State Transfer라는 용어의 약자로서 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었다.
로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에
안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 한다.
1 - 2) REST 구성
REST API는 크게 세 가지로 구성되어있다.
자원(Resource) - URI
행위(Verb) - HTTP METHOD
표현(Representations)
1 - 3) REST의 특징
Uniform (유니폼 인터페이스)
Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.
Stateless (무상태성)
REST는 무상태성 성격을 갖는다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.
세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다.
때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
Cacheable (캐시 가능)
REST의 가장 큰 특징 중 하나는 HTTP라는 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다.
HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
Self-descriptiveness (자체 표현 구조)
REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것이다.
Client - Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로
각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.
계층형 구조
REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고
PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있다.
2. REST API 디자인 가이드
REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있다.
첫 번째, URI는 정보의 자원을 표현해야 한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.
2 - 1) URI
슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.
URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
하이픈(-)은 URI 가독성을 높이는데 사용
밑줄(_)은 URI에 사용하지 않는다.
URI 경로에는 소문자가 적합하다.
파일 확장자는 URI에 포함시키지 않는다.
2 - 2) Method
POST, GET, PUT, DELETE 이 4가지의 Method를 가지고 CRUD를 할 수 있다.
| METHOD | 역할 |
| POST | CREATE |
| GET | READ |
| PUT | UPDATE |
| DELETE | DELETE |
2 - 3) Collection과 Document
Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워진다.
DOCUMENT는 단순히 문서로 이해해도 되고, 한 객체라고 이해하면 될 것 같다.
컬렉션은 문서들의 집합, 객체들의 집합이라고 생각하면 될 것이다.
컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현된다.
여기서 중요한 점은 컬렉션은 복수로 사용해야 한다는 점이다.
컬렉션이 다큐먼트의 모음이기 때문이다.
따라서 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 이해하기 쉬운 URI를 설계할 수 있다.
3. HTTP 응답 상태 코드
마지막으로 응답 상태코드에 대해 알아보자.
잘 설계된 REST API는 URI와 METHOD에 대한 표현만이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다.
정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 중요한 일이다.
혹시 200이나 4XX관련 특정 코드 정도만 사용하고 있다면 처리 상태에 대한 좀 더 명확한 상태코드 값을 사용할 수 있기를 권장한다.
200 : 클라이언트의 요청을 정상적으로 수행한경우
201 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)
400 : 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401 : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
404 : 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
405 : 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드
301 : 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
500 : 서버에 문제가 있을 경우 사용하는 응답 코드