REST API

REST(Respresentational State Transfer:  자원의 상태 전달) - 네트워크 아키텍처

 

1. Client, Server: 클라이언트와 서버가 독립적으로 분리 되어 있어야 한다.

2. Stateless: 요청에 대해서 클라이언트의 상태를 서버에 저장하지 않는다.

3. Cache: 클라이언트는 서버의 응답을 Cache(임시저장) 할 수 있어야 한다.

클라이언트가 Cache를 통해서 응답을 재사용할 수 있어야 한다. 이를 통해서 서버의 부하를 낮춘다.

4. 계층화( Layered System): 서버와 클라이언트 사이에, 방화벽, 게이트웨이, Proxy 등 다양한 계층 형태로 구성이 가능해야 하며, 이를 확장 할 수 있어야 한다.

5. 인터페이스 일관성: 인터페이스의 일관성을 지키고, 아키텍처를 단순화시켜 작은 단위로 분리하여, 클라이언트, 서버가 독립적으로 개선 될 수 있어야 한다.

6. Code on Demand (Optional): 자바 애플릿, 자바스크립트, 플래시 등 특정한 기능을 서버로 부터 클라이언트가 전달받아 코드를 실행 할 수 있어야 한다.

 

다음의 인터페이스 일관성이 잘 지켜졌는지에 따라, REST를 잘 사용했는지 판단을 할 수 있다.

 

1. 자원의 식별

웹 기반의 REST에서는 리소스 접근을 할 때 URL를 사용 합니다.

 

2. 메시지를 통한 리소스 조작

Web에서는 다양한 방식으로 데이터를 전달 할 수 있다.

그 중에서 가장 많이 사용하는 방식은 HTML, XML, JSON, TEXT 등 이 있다.

이 중에서 어떠한 타입의 데이터인지를 알려주기 위해서 HTTP Header 부분에 content-type을 통해서 데이터의 타입을 지정해 줄 수 있다.

또한 리소스 조작을 위해 데이터 전체를 전달 하지 않고, 이를 메시지로 전달 합니다.

EX) 서버의 USER 라는 정보의 전화번호를 처음에는 NUMBER 라고 결정했고, 이 정보를 Client와 주고 받을 때, 그대로 사용하고 있다면, 후에 서버의 resource 변경으로 phone-number 로 바뀌게 된다면 Client는 처리를 하지 못하고 에러가 난다.

이러한 부분을 방지하기 위해서 별도의 메시지의 형태로 데이터를 주고 받으며, client-server가 독립ㅈ거으로 확장 가능하도록 한다.

 

3. 자기 서술적 메시지

요청 하는 데이터가 어떻게 처리 되어져야 하는지 충분한 데이터를 포함 할 수 있어야 한다.

 

HTTP 기반의 REST에서는 HTTP Method와 Header 정보, 그리고 URL의 포함되는 정보로 표현 할 수 있어야 한다.

GET: 사용자의 정보 요청

POST: 사용자 정보 생성

PUT: 사용자 정보 생성 및 수정

DELETE: 사용자 정보 삭제

 

그 외에 담지 못 한 정보들은 URL의 메시지를 통하여 표현 한다.

 

4. 애플리케이션 상태에 대한 엔진으로써 하이퍼미디어

 

REST API를 개발할 때 단순히 Client 요청에 대한 데이터만 응답 해주는 것이 아닌 관련된 리소스에 대한 Link 정보까지 같이 포함 되어져야 한다.

 

이러한 조건들을 잘 갖춘 경우 Rest Ful 하다고 표현하고, 이른 REST API라고 부른다.

 

이러한 점은 규약이고 반드시 이 정도는 지켜야 한다고 생각하면 된다.

 

4번째는 잘 사용하지 않을 수 있는데 클라이언트를 개발 할 때 서버 API 스펙을 보고 데이타 클래스를 매핑하는데 주소 정보까지 매핑한다고 하면 서버에서 받아오는 데이터 외의 다른 정보까지 매핑해야 하기 떄문에 잘 사용하지 않는다.