REST(Representational State Transfer) API

REST API

Representational State Transfer의 약자로 웹의 장점을 최대한 활용할 수 있는 아키텍처로 처음 소개되었다. REST API는 웹에서 사용되는 데이터, 리소스를 HTTP URI로 표현하고 HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.

좋은 REST API 디자인하기, 리차든 성숙도 모델

리차든 성숙도 모델 (RMM)은 총 4단계로 나누어진다.

이 모든 단계를 충족해야 REST API라고 부를 수 있지만 3단계는 충족하기 어렵기 때문에 2단계만 지키더라도 좋은 API 디자인이다. 이런 경우 HTTP API라고 부른다.

REST 성숙도 모델 0단계

0단계는 단순히 HTTP 프로토콜을 사용해도 된다. 

REST 성숙도 모델 1단계

1단계에서는 개별 리소스와 통신을 준수해야한다. 모든 자원을 개별 시소스에 맞는 Endpoint를 사용해야한다는 것. 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 것이다.

어떤 리소스를 변화시키는지, 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에 적절한 엔드포인트를 작성하는 것이 중요하다.

엔드포인트 작성 시에는 동사, HTTP 메소드, 혹은 어떤 행위에 대한 단어 사용은 지양하고 리소스에 집중해 명사 형태의 단어로 작성하는 것이 좋다.

또한, 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

REST 성숙도 모델 2단계

CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것이다. 0단계와 1단계는 모든 요청을 CRUD에 상관없이 POST로 하고 있다.

API를 작성할 때, 2단계까지 적용하면 대체적으로 잘 작성된 API라고 본다.

[메소드 사용 규칙]

• GET : 서버의 데이터를 변화시키지 않는 요청에 사용
• POST : 요청마다 새로운 리소스를 생성
• PUT : 요청마다 같은 리소스를 반환, 교체의 역할
• PATCH : 수정의 용도

REST 성숙도 모델 3단계

HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계는 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다.