Rest API

REST(Representational State Transfer)

자원(Resource)을 정의하고 자원에 대한 주소를 지정하는 방법

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)를 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미

 

 

REST 구성요소

1. 자원(Resource): URI

 - 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.

 - 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.

 - Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

 

2. 행위(Verb): HTTP Method

 - HTTP 프로토콜의 Method를 사용한다.

 - HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.

 

3. 표현(Representation of Resource)

 - Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.

 - REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.

 - JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

 

 

REST API

REST 기반으로 서비스 API를 구현한 것

 

 

Rest API 장점

- HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.

- HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.

- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.

- Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.

- REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.

- 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.

- 서버와 클라이언트의 역할을 명확하게 분리한다.

 

 

Rest API 단점

- 표준이 존재하지 않는다.

- 사용할 수 있는 메소드가 4가지 밖에 없다. (HTTP Method 형태가 제한적이다.)

- 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.

- 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.

 

 

Rest API Method

GET - Resource 조회

POST - Resource 생성

PUT - Resource 수정

DELETE - Resource 삭제

 

 

REST API 설계 규칙

- URL은 심플하고 직관적으로 처리

- 가독성을 위해 _대신 -를 사용한다. 대문자가 아닌 소문자를 사용한다.

- 행위(method)를(get, delete 등) URL을 포함하지 않는다.

- 함수처럼 컨트롤 리소스를 나타내는 URL은 동작을 포함하는 이름을 짓는다.

- 동사보다는 명사를 사용

- 단수 보다는 복수형 사용

- 상세 내용은 HTTP body에 표현하는 게 좋음

- 하위 호환성을 보장하기 위해 버전관리 필요