나도 할 수 있다 REST API

 채용 공고를 보면 REST에 대한 내용이 정말 많습니다. 그래서 저도 정말 많이 찾아봤는데 처음엔 도통 무슨 말인가 이해가 하나도 되질 않았습니다. 안드로이드에서 Retrofit으로 서버와 통신을 할 때 도, 심지어 그 서버를 내가 만들어 놓고도 REST 방식인지도 몰랐습니다. 그래서 저 같은 사람도 쉽게 이해할 수 있도록 제 방식대로 쉽게 풀어보고자 합니다.

📌 REST 의 정의

우선 REST가 뭔지 검색을 해보면 대개 이렇게 설명을 합니다.

REST는 "Representational State Transfer"의 약자로, 자원을 URI(Uniform Resource Identifier)로 표현하고 해당 자원의 상태를 주고 받는 웹 아키텍처 스타일입니다. HTTP 프로토콜을 기반으로 하며, 클라이언트와 서버 간의 통신을 단순화하고 유연하게 만들어줍니다.

 

예 뭔소린지 모르겠죠 ? 저도 처음 봤을 때 제가 말하는 감자인줄 알았습니다.

 

REST는 Representational State Transfer의 약자입니다. 아래 그림을 보면 알 수 있듯이  네트워크 HTTP 프로토콜을 사용해 클라이언트와 서버가 데이터를 주고 받는 기술중에 하나입니다.

 

이 때 이 요청은 URL을 통해서 이뤄지고 이 URL을 딱 봤을 때 얘가 뭔짓을 하려는 건지 딱 알 수 있어야 RESTFUL 하다 라고 합니다. GET은 서버에게 데이터를 요청하는 메소드입니다.  예시를 보고 한번 생각해 보겠습니다. 아래 URL은 db와 storeinfo 두 가지로 나눌 수 있습니다. 그럼 이 URL 은 무슨 요청을 보내는걸까요 ? 

GET /db/storeinfo

 

db -> 말 그대로 Database에서 뭔가를 가지고 오려 합니다. 뭐를 가지고 오려 할까요 ? 그 다음 요소인 storeinfo 즉, 매장의 정보를 보내달라는 요청입니다.  이렇게 클라이언트가 URL을 통한 요청을 Server에 보낼 때 그 의도를 알 수 있는게 REST 방식입니다.

 

📌 REST API의 구성

• 자원(Resource) : 모든 자원엔 고유한 ID(/db/storeinfo 같은 HTTP URL)이  있고 이 자원은 서버에 항상 존재합니다.
• 행위(Verb) : HTTP Method [ GET, POST, PUT, DELETE ] 를 사용하는데 이 Method들은 각각 Database에서의 [ CREATE, INSERT, UPDATE, DELETE ]  의 역할을 담당합니다. 
• 표현(Representations) : 클라이언트에서 자원을 요청하면 서버측에서는 적절한 응답을 전송합니다. 이 때, 응답 데이터 형태는 JSON, XML, TEXT, RSS 등 여러 형태로 나타낼 수 있는데 이 중 JSON을 가장 많이 사용합니다.

 

📌 REST API를 사용하는 이유

 Rest API를 사용하게 된 가장 큰 이유는 다양한 플랫폼과 디바이스에서 일관된 방식으로 서버와 통신하기 위함입니다. 예전에는 PC 브라우저가 주된 클라이언트였기 때문에 서버는 이에 맞춰 웹 페이지를 제공하는 방식으로 충분 했습니다. 하지만 다양한 스마트 기기의 등장으로 다양한 디바이스에서 웹, 앱을 전체를 아우르면서 일관된 방식으로 데이터를 주고받아야 하는 필요성이 생겼습니다.

 

📌 REST API 특징

• Uniform(유니폼 인터페이스) : 웹 서비스에서 일관성 있고 통일된 방식으로 리소스를 다루기 위한 원칙입니다.
• Stateless(무상태성) : 세션, 쿠키 정보등을 따로 관리하지 않기 때문에 서버는 클라이언트의 요청만 처리하면 됩니다.
• Cacheable (캐시 가능) : HTTP의 캐싱 기능을 사용할 수 있습니다.
• Self-descriptiveness (자체 표현 구조) :  계속 강조되는 내용입니다. REST API 메시지만(요청 URL) 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있습니다.
• Client - Server 구조 : REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분 되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어듭니다.
• 계층형 구조 : REST 서버는 다중 계층으로 구성될 수 있습니다. 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, GateWay 같은 네트워크 기반의 중간매체를 사용할 수 있습니다.

📌 REST API 장점

• HTTP 프로토콜의 인프라를 그대로 사용하기 때문에 별도의 인프라를 구축할 필요가 없습니다.
• HTTP Method를 그대로 사용합니다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능합니다.
• 서버와 클라이언트의 역할을 명확하게 분리합니다.

📌 REST API 단점

• 표준이 존재하지 않습니다.
• 사용할 수 있는 Method가 4가지 밖에 없고 HTTP Method 형태가 제한적입니다.
• 구형 브라우저가 지원해주지 못하는 부분(PUT, DELETE, pushState)가 존재합니다.

📌 REST API 설계 원칙

• REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.
  ① URI는 정보의 자원을 표현해야 합니다. ( URI가 어떤 요청을 하는건지 알 수 있어야 합니다 )
  ② 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현해야 합니다.
• 리소스 명은 동사보다는 명사를 사용합니다.
• 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용합니다.
• URI 마지막 문자로 슬래시(/)를 포함하지 않습니다.
• 하이픈(-)은 URI 가독성을 높이는데 사용합니다.
• URI 경로에는 소문자가 적합합니다.
• 파일 확장자는 URI에 포함시키지 않습니다.

GET /members/delete/1

 

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. 왜 그럴까요 ?

• URI는 자원을 표현하는데 중점을 두어야 합니다.
• delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.

📌 HTTP 응답 상태 코드

✅ 2XX 상태 코드

상태 코드	설명
200	클라이언트 요청 정상 수행
201	클라이언트의 리소스가 성공적으로 생성(POST)
202	클라이언트의 요청이 비동기적으로 처리
204	클라이언트의 요청을 정상적으로 수행함.  200과 다른 점은  응답 바디가 없을 때 사용

 

✅ 4XX 상태 코드

상태코드	설명
400	클라이언트의 요청이 부적절
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스 요청
403	응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때
404	클라이언트가 요청한 리소스가 존재 하지 않을 때
405	클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우

 

✅ 기타 상태 코드

상태코드	설명
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때
500	서버에 문제가 있을 때