REST API

REST API

---

REST API란 REST를 기반으로 만들어진 API를 의미한다. 여기서 REST의 뜻은 Representational State Transfer의 약자로  이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미한다. 좀 더 구체적으로 뜻을 풀어보면 HTTP URI를 통해 자원을 명시하고 아래의 HTTP Method (POST, GET, PUT, DELETE)를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다. 

 

Method	Action	역할	페이로드
GET	index/retrieve	모든/특정 리소스를 조회	X
POST	create	리소스를 생성	O
PUT	replace	리소스의 전체를 교체	O
PATCH	modify	리소스의 일부를 수정	O
DELETE	delete	모든/특정 리소스를 삭제	X

 

월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템에서 소프트웨어를 개발할 시 네트워크 상에서 Client와 Server 사이의 통신 방식을 REST API의 아키텍처 형식으로 개발함으로써 모든 데이터 구조와 처리방식이 매우 직관적으로 이해하기 쉬워져 API의 이해도 및 호환성을 높일 수 있다. 즉, 정보들이 주고받아지는 데 있어서 개발자들 사이에 널리 쓰이는 일종의 형식이자 약속이라고 할 수 있다.

 

 REST 구성 요소

---

구성 요소	내용	표현 방법
Resource	자원	HTTP URI
Verb	자원에 대한 행위	HTTP Method
Representations	자원에 대한 행위의 내용	HTTP Message Pay Load

• Resource : 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
• Verb : HTTP 프로토콜의 Method인 GET, POST, PUT, DELETE 사용한다.
• Representations : REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어질 수 있지만, JSON 혹은 XML를 통해 데이터를 주고받는 것이 일반적이다.

 

REST의 특징

---

• Uniform (유니폼 인터페이스)

: HTTP 표준에만 따른다면, 안드로이드/IOS 플랫폼이든, 특정 언어나 기술에 종속되지 않고 모든 플랫폼에 사용할 수 있으며, URI로 지정한 리소스에 대한 조작이 가능한 아키텍처 스타일을 의미한다.

 

• Stateless (무상태성)

: 작업을 위한 상태 정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 그래서 서시스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

• Cacheable (캐시 기능)

: REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능이 적용할 수 있다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

 

• Self-descriptiveness (자체 표현 구조)

: REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다는 것이다.

 

• Client - Server 구조

: REST 서버는 API 제공, 클라이언트는 사용자 인증이나 콘텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로 간 의존성이 줄어들게 된다.

 

• 계층형 구조

: REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있게 한다.

 

REST API 설계 규칙

---

1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

2. 마지막에 슬래시 (/)를 포함하지 않는다.

3. 언더바 대신 하이폰을 사용한다.

4. 파일 확장자는 URI에 포함하지 않는다.

5. 행위를 포함하지 않으며, HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다. 

 

CRUD	HTTP Verbs	Route
resource들의 목록을 표시	GET	/resource
resource 하나의 내용을 표시	GET	/resource/:id
resource를 생성	POST	/resource
resource를 수정	PUT(전체 변경)	/resource/:id
	PATCH(일부 변경)	/resource/:id
resource를 삭제	DELETE	/resource/:id

 

응답 코드

---

상태	내용
1XX	전송 프로토콜 수준의 정보 교환.
2XX	클라이언트 요청이 성공적으로 수행됨.
3XX	클라리언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함.
4XX	클라이언트의 잘못된 요청.
5XX	서버쪽 오류로 인한 상태 코드.