REST API를 이용하여 인터넷상에 공유되는 API를 활용하거나 REST API 서버를 구축하여 서비스의 자원을 공유하는 시스템을 구축하기에 앞서 REST에 대한 내용을 정리하고 개념을 이해하고자 합니다.
REST 란?
REST는 Representational State Transfer의 약자로 2000년도 로이필링의 박사학위 논문에서 소개되었습니다. 그리고 이 REST는 RESTful이라는 용어로 지징되어 사용되기도 합니다.
로이 필딩은 웹(HTTP)의 장점을 최대할 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다.
REST는 자원을 정의하고 자원에 대한 주소를 지정하여 웹 상의 자료를 HTTP 위에서 별도의 전송 계층 없이 자원을 전송하기 위한 아주 간단한 인터페이스인 ‘네트워크 아키텍처 원리’의 모음입니다.
REST의 특징
아래의 REST API의 특징은 100%로 이해가 되지는 않지만 REST API를 직접 호출해보고 API 서버를 구축하는 테스트를 진행해 보면서 REST API 만의 특징 및 장/단점을 이해하는 것이 좋을 것 같습니다.
REST API의 특징을 인식하면서 테스트를 수행하고 상세한 설명은 추가 보완할 수 있도록 하겠습니다.
1) Uniform (유니폼 인터페이스)
Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.
2) Stateless (무상태성)
REST는 무상태성 성격을 갖습니다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.
3) Cacheable (캐시 가능)
REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다. HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능합니다.
4) Self-descriptiveness (자체 표현 구조)
REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것입니다.
5) Client – Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.
6) 계층형 구조
REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 합니다.
REST API 디자인
ㅇ 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현
URI를 요청하는 메소드로는 아래와 같습니다. 메소드 별로 수행하는 역할이 아래와 같이 정의되어 있으며 수행하는 역할별로 적절한 메소드를 정의하여 API를 호출할 수 있도록 표현하는 것이 좋겠습니다.
ㅇ POST : POST를 통해 해당 URI를 요청하면 리소스를 생성합니다.
ㅇ GET : GET를 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
ㅇ PUT : PUT를 통해 해당 리소스를 수정합니다.
ㅇ DELETE : DELETE를 통해 리소스를 삭제합니다.
ㅇ URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)
URI을 작성할 경우 제공할 정보의 자원을 명확히 표현해야 합니다. URI는 자원을 정의하고 표현하기 위한 수단으로 명사의 형태로 작성을 해야 합니다.
예를 들어 위치 정보를 제공하는 API라면 ‘GET /location’ 과같은 형태로 URI를 정의합니다.
ㅇ 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
제공할 정보에 대하여 계층 구조를 가질 수 있도록 설계하면 좀 더 구체적이고 명확한 정보를 요청하고 제공 받을 수 있습니다.
예를 들어 ‘위치 정보 – 집 : GET /location/house’, ‘위치 정보 – 바다 : GET /location/sea’ 와 같이 정보를 계층구조로 세분화하고 URI의 슬래시 구분자를 이용하여 API 구조를 설계할 수 있겠습니다.
ㅇ URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.
URI 마지막에 슬래시(/)가 있는 것과 없는 것은 서로 다른 URI이고 자원이 다르다고 인식을 합니다.
ㅇ 하이픈(-)은 URI 가독성을 높이는데 사용하고 밑줄(_)은 URI에 사용하지 않는다.
URI를 설계할 경우 가능한 명사로 표현하고 계층 구조를 가질 수 있도록 설계를 하는 것이 좋겠습니다. 명사로 정보를 표현함에 있어서 여러개의 명사를 이어 정보를 좀 더 상세하게 표현하고자 한다면 하이픈(-)을 사용하여 명사를 이어주고 가능한 밑줄(_)은 사용하지 않는 것이 좋겠습니다.
이유는 밑줄을 사용할 경우 URI에 하이퍼링크 등이 적용되었을 경우 밑줄이 생성되어 있어 중복이 되기 때문에 밑줄을 식별하기 어려울 수 있고 밑줄(_) 커서로 인하여 URI의 밑줄(_)이 가려져서 식별이 어려울 수 있습니다.
URI의 가독성을 위하여 가능한 하이픈(-)을 사용하는 것을 권장합니다.
ㅇ URI 경로에는 소문자가 적합하다.
URI는 대소문자에 따라 다른 리소스로 인식하기 때문이고 RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이라고 합니다.
API 호출에 대한 응답 상태 코드
REST API는 HTTP 기반으로 동작되는 인터페이스로서 HTTP의 응답 상태 코드와 동일한 형태로 REST API를 호출했을 때의 상태를 리턴해 줍니다.
API 호출에 대하여 명확하게 상태를 Return하는 것이 API를 호출함에 있어 결과에 대한 이해와 문제 발생에 대한 원인을 찾기 위하여 접근하는 방향을 제시할 수 있습니다.
상태코드에 따른 설명은 아래와 같습니다.
ㅇ 200 : 클라이언트의 요청을 정상적으로 수행 (OK)
ㅇ 201 : 클라이언트가 어떠한 리소스 생성을 요청했을 경우 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)
ㅇ 400 : 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
ㅇ 401 : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
(로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
ㅇ 403 : 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
(403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)
ㅇ 405 : 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드
ㅇ 301 : 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
(응답 시 Location header에 변경된 URI를 적어 줘야 합니다.)
ㅇ 500 : 서버에 문제가 있을 경우 사용하는 응답 코드
레퍼런스
ㅇ https://meetup.toast.com/posts/92
ㅇ https://ko.wikipedia.org/wiki/REST
마치며
제가 REST API를 이해하기 위하여 검색한 내용과 이해되는 범위 내에서 정리하였습니다.
REST API에 대한 상세 내용은 레퍼런스를 참고하거나 REST API에 대한 논문을 찾아보는 것이 좀 더 정확할 것이라고 생각합니다.
위 내용을 기반으로 REST API에 대한 테스트를 수행하고 더 나아가 API 서버를 구축하는 테스트를 진행할 예정입니다.
REST API 호출에 대한 테스트를 하고 제공받는 정보를 가공하는 것에 익숙해지고 라이브러리화 한다면 다양한 서비스(ex. 네이버, 카카오 등)에서 제공하는 API를 활용하여 정보를 수집하고 통합하여 새로운 나만의 서비스를 구현할 수 있을 것이라고 생각합니다.