REST 성숙도 모델

 레오나르드 리처드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다. 

 

 ↓ REST API에 관한 글은 아래 포스팅 참고 🐱

REST API란 무엇일까?

 

출처: https://martinfowler.com/articles/richardsonMaturityModel.html

 리처드슨의 REST 성숙도 모델은 총 4단계(0 ~ 3단계)로 나누어져 있으며, 각 단계에 따라 충족해야 할 조건이 있다. 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계 까지만 적용해도 좋은 API 디자인알고 볼 수 있다.

 

 

👾 Level 0. HTTP 사용

 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 하면 된다. 물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계이다.

 웹 메커니즘을 사용하지 않고 HTTP를 원격 통신을 위한 전송 시스템으로 사용한다. RPC(Remote Precedure Call) 형태로 리소스 구분 없이 설계된 HTTP API이다.

 단 하나의 endpoint를 사용하고, 전달되는 서로 다른 매개변수를 통해 하나의 endpoint에서 여러 동작을 하게 된다. 매개 변수를 body로 전달하기 위해 HTTP method는 POST가 된다.

 

 

👩🏻‍💻 example

허준이라는 이름의 주치의의 예약 가능한 시간을 확인하고, 어떤 특정 시간에 예약하는 상황

→ 단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.

 

 

👾 Level 1. 개별 리소스와의 통신 준수

 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.

📎 REST API 모범 사례 - REST 엔드포인트 설계 예시

 

 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요하다. 엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.

 

 

👩🏻‍💻 example

 → 0단계 에서는 요청에서의 엔드포인트로 모두 /appointment를 사용하였지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용한다.

 

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

 

 

👾 Level 2. HTTP 메서드 원칙 준수

 2단계에서는 HTTP method인 GET, POST, PUT, DELETE를 사용해 CRUD를 나타내고 메시지에 Status Code도 담겨 반환한다.

 앞서 0단계와 1단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메서드를 사용하지만 이는 적절한 사용법이 아니다.

 

👩🏻‍💻 example

 → 조회(READ)하기 위해서는 GET 메서드를 사용하여 요청을 보내고, 이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다.

 → 생성(CREATE)하기 위해서는 POST 메서드를 사용하여 요청을 보내야 하며, POST 요청에 대한 응답이 어떻게 반환되는지가 중요하다. 이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 한다.

 

---

📌 HTTP 요청 메서드 유의사항

 • GET 메서드의 경우 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.

 • POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등 하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드 POST는 구분하여 사용해야 한다.

 • PUT 메서드와 PATCH 메서드도 구분하여 사용하여야 하는데, PUT은 교체, PATCH는 수정의 용도로 사용한다.

---

 

👾 Level 3. HATEOAS 원칙 준수

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

 이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션에 대한 정보를 넣어주며, 이렇게 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심이다. 만약 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있다.

 

👩🏻‍💻 example

 

 → 허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수 있다.

 

 

✔️ 현재 가장 많은 REST API가 2단계에 해당하며, API를 작성할 때 REST 2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다.

 

---

출처: 코드스테이츠 SEB

✏️ 공부하며 정리한 내용입니다. 잘못된 정보나 더 공유할 내용이 있으면 댓글로 알려주세요!

읽어주셔서 감사합니다 😊