요즘들어 잠을 자는 시간이 엄청 짧아 진 것 같다. 그래서 아침에 일어날 때마다 눈꺼풀이 너무너무 무겁다. 물론 지금도 졸린 눈을 하며 TIL을 적고 있다.
REST API를 개발할 때 참고하면 좋을 자료들을 발견해 오늘의 TIL에 적어보려고 한다.
RESTful API
REST란 어떤 자원에 대해 CRUD(Create, Read, Update, Delete) 연산을 수행하기 위해 URI(Resource)로 요청을 보내는 것으로, GET, POST, PUT, PATCH, DELETE 등의 방식(Method)을 사용하여 요청을 보내며, 요청을 위한 자원은 특정한 형태(Representation of Resource)으로 표현된다. 그리고 이러한 REST 기반의 API를 웹으로 구현한 것이 RESTful API이다.
예를 들어, 우리는 게시글을 작성하기 위해 kimkj.shop/board 라는 URI에 POST방식을 사용하여 JSON형태의 데이터를 전달할 수 있다. 위와 같이 CRUD 연산에 대한 요청을 할 때, 요청을 위한 Resource(자원, URI)와 이에 대한 Method(행위, POST) 그리고 Representation of Resource(자원의 형태, JSON)을 사용하면 표현이 명확해지므로 이를 REST라 하며, 이러한 규칙을 지켜서 설계된 API를 REST API 또는 RESTful한 API라고 한다.
이러한 REST API는 Resource(자원), Method(행위), Representation of Resource(자원의 형태)로 구성된다.
REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약
- URI는 정보의 자원을 표현해야 한다.
- 자원에 대한 행위는 HTTP Method(주로 GET, POST, PUT, DELETE)로 표현한다.
REST 특징
- Uniform Interface(일관된 인터페이스)
Uniform Interface란, Resource(URI)에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미한다. 이것은 클라이언트가 특정 언어나 기술에 종속받지 않는 특징을 의미한다. 이러한 특징 덕분에 REST API는 HTTP를 사용하는 모든 플랫폼에서 요청가능하며, Loosely Coupling(느슨한 결합) 형태를 갖게 되었다.
- Stateless(무상태성)
서버는 각각의 요청을 별개의 것으로 인식하고 처리해야 하며, 이전 요청이 다음 요청에 연관되어서는 안 된다. 그래서 REST API는 세션 정보나 쿠키 정보를 활용하여 작업을 위한 상태정보를 저장 및 관리하지 않는다. 이러한 무상태성때문에 REST API는 서비스의 자유도가 높으며, 서버에서 불필요한 정보를 관리하지 않으므로 구현이 단순하다. 이러한 무상태성은 서버의 처리 방식에 일관성을 부여하고, 서버의 부담을 줄이기 위함이다.
- Cacheable(캐시 가능)
REST API는 결국 HTTP라는 기존의 웹 표준을 그대로 사용하기 때문에, 웹의 기존 인프라를 그대로 활용할 수 있다. 그러므로 REST API에서도 캐싱 기능을 적용할 수 있는데, HTTP 프로토콜 표준에서 사용하는 Last-Modified Tag 또는 E-Tag를 이용하여 캐싱을 구현할 수 있고, 이것은 대량의 요청을 효율적으로 처리할 수 있게 도와줍니다.
- Client-Server Architecture (서버-클라이언트 구조)
REST API에서 자원을 가지고 있는 쪽이 서버, 자원을 요청하는 쪽이 클라이언트에 해당한다. 서버는 API를 제공하며, 클라이언트는 사용자 인증, 세션, 로그인 정보 등을 직접 관리하는 등 역할을 확실히 구분시킴으로써 서로 간의 의존성을 줄인다.
- Self-Descriptiveness(자체 표현)
REST API는 요청 메세지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다. 아래와 같은 JSON 형태의 REST 메세지는 kimkj.shop/board 로 게시글의 제목, 내용을 전달하고 있음을 손쉽게 이해할 수 있습니다. 또한 board라는 데이터를 추가(POST)하는 요청임을 파악할 수 있다.
HTTP POST , http://kimkj.shop/board
{
"board":{
"title":"제목",
"content":"내용"
}
}- Layered System(계층 구조)
REST API의 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있다. 또한 Proxy, Gateway와 같은 네트워크 기반의 중간 매체를 사용할 수 있게 해준다. 하지만 클라이언트는 서버와 직접 통신하는지, 중간 서버와 통신하는지 알 수 없다.
REST 규칙
- URI는 명사를 사용한다.
- 슬래시로 계층 관계를 표현한다.
- URI의 마지막에는 슬래시를 붙이지 않는다.
- URI는 소문자로만 구성한다.
- 가독성이 떨어지는 경우 하이픈을 사용한다.
- 언더바(_)는 사용하지 않는다.
참고
망나니개발자 . “[Server] Restful API란?” MangKyu's Diary, TISTORY, 25 June 2021, https://mangkyu.tistory.com/46.
“Rest Api 제대로 알고 사용하기.” NHN Cloud Meetup, https://meetup.toast.com/posts/92.
