[Network] RESTful API

 

 

RESTful API(Respresentational State Transfer API)

 

 

API는 Application Programming Interface로 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙이다. 그렇다면 RESTful이 붙어있는 REST란 무엇일까? 

 

 

REST란 자원을 이름으로 구분하여 해당 자원의 상태 및 정보를 주고받는 모든 것을 의미한다. 즉, 자원은 해당 소프트웨어가 관리하는 모든 문서, 그림, 데이터 등이고, 자원의 이름은 데이터베이스의 내 정보가 자원일때, '유정인'을 자원의 이름으로 이를 구분한다. 이러한 상태 및 정보를 데이터가 요청되어지는 시점에서 JSON 혹은 XML을 통해 주고받는다.

REST는 HTTP URI(Uniform Resource Identifier)를 통해 자원을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD를 적용하여 자원을 처리하도록 설계된 아키텍쳐이다.

REST의 장점과 단점을 다음과 같이 이해할 수 있다.

• 장점 
  1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API사용을 위한 별도의 인프라를 구축할 필요가 없다.
  2. HTTP의 표준을 최대한 활용할 수 있다.
  3. 서버와 클라이언트의 역할을 명확하게 분리할 수 있다.
• 단점
  1. 표준이 존재하지 않는다.
  2. 사용할 수 있는 메서드가 4가지(POST, GET, PUT, DELETE) 밖에 없다.
  3. 구형 브라우저가 지원하지 못하는 경우가 있다.

 

 

RESTful API는 AWS에서 다음과 같이 설명하고 있다.

두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스 입니다.

RESTful이란 REST를 REST 답게 쓰기위한 방법으로, 누군가가 공식적으로 발표한 것은 아니다. 단지 REST 원리를 따르는 시스템을 RESTful이라는 용어로 지칭된다. 이해하기 쉽고 사용하기 쉽도록 만드는 것을 말하고, 성능의 향상 목적은 아니다.

일관적인 컨벤션을 통해 API의 이해도 및 호환성을 높이기 위한것이다. 이와 반대로 CRUD기능을 POST로만 처리하는 경우 API의 목적성이 뚜렷하지 않아 이해하기 힘들다. 

 

 

RESTful API 예시

 

 

다음은 REST API 설계 예시이다.

CRUD	HTTP verbs	Route
목록표시	GET	/resource
생성	POST	/resource
수정	PUT	/resource:id
삭제	DELETE	/resource:id

 

 

다음은 응답상태 코드의 예시다.

1xx	전송 프로토콜 수준의 정보교환
2xx	클라이언트의 요청이 성공함
3xx	클라이언트의 요청을 위해 추가적인 행동이 필요함
4xx	클라이언트의 잘못된 요청
5xx	서버의 오류로 인한 상태코드