REST API

REST API

REST API에서 REST는 “Representational State Transfer”의 약자로, 로이 필딩의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었다. REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식이다.

Richardson 성숙도 모델(RMM)

3단계까지 지키기는 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인(HTTP API)

✅ REST 성숙도 모델 0단계

단순히 HTTP 프로토콜만 사용 - REST API라고 할 수 없으며, 0단계는 REST API 작성을 위한 기본 단계

✅ REST 성숙도 모델 1단계

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

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

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

✅ REST 성숙도 모델 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP메소드를 사용하는 것에 중점을 둔다. 응답코드도 명확하게 작성!

❗️HTTP 메소드 사용 규칙

• GET 메소드는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
• POST 메소드는 요청마다 새로운 리소스를 생성하고 PUT 메소드는 요청마다 같은 리소스를 반환한다. PUT과 같이 요청마다 같은 리소스를 반환하는 특징을 멱등성이라고 한다.
• 멱등성을 가진 메서드인 PUT과 PATCH는 PUT은 교체, PATCH는 수정의 용도로 구분하여 사용해야 한다.
  

✅ REST 성숙도 모델 3단계

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