TIL) REST API, REST API를 디자인하는 방법

 

API의 대표적인 아키텍처인 REST API

어떻게 요청과 응답을 하는 것이 바람직한 방법인가?

👇👇

REST API

“Representational State Transfer”의 약자

웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.

 

HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요한데, 이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요하다.

 

로이 필딩 (Roy Fielding)의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었다.

---

REST API를 디자인하는 방법

레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델

Richardson 성숙도 모델 (RMM)

0단계 : HTTP 사용

1단계 : 개별 리소스와 통신 준수

2단계 : HTTP 메소드 원칙 준수

3단계 : HATEOAS 원칙 준수

 

👉 이 모든 단계를 충족해야 REST API라고는 하지만, 실제로는 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API라고 부른다. 

---

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다.

물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계이다. 

 

클라이언트는 서비스별로 유일한 URL 끝점에 HTTP POST 요청을 하여 서비스를 호출한다.

요청을 할 때마다 어떤 액션을 수행할지, 그 대상(예: 비즈니스 객체)은 무엇인지 지정하고, 필요한 매개변수도 함께 전달한다.

 

0 단계에서는 API 서비스를 위해 단 하나의 endpoint 를 사용한다.

그리고 전달되는 서로 다른 매개변수를 통해서 하나의 endpoint로 여러 동작을 하게 된다.

매개변수를 Body 로 전달하기 위해 HTTP method 는 POST 가 된다.

 

 

---

REST 성숙도 모델 - 1단계

1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다. 

 

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

클라이언트는 수행할 액션과 매개변수가 지정된 POST 요청을 한다.

 

HTTP headers 에 Content-Type 이나 Cache 관련 정보를 전혀 제공하고 있지 않다.

 

➥ 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용했다. 

 

- 예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원(리소스)은 허준이라는 의사의 예약 가능한 시간대이다.

그래서 요청 시 /doctors/허준이라는 엔드포인트를 사용했다. 

- 특정 시간에 예약하게 되면, 실제 slots라는 리소스의 123이라는 id를 가진 리소스가 변경되기 때문에, 하단의 특정 시간에 예약이라는 요청에서는 /slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용했다. 

 

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

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

 

---

REST 성숙도 모델 - 2단계

CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 

앞서 0단계와 1단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메서드를 사용하고 있는데, 2단계에서는 CRUD에 따른 적합한 메서드를 사용한다!

 

Resource 를 URI 로 식별하고, HTTP method 를 사용해서 CRUD 를 표현하는데,

2 단계에서는 HTTP method 인 GET, POST, PUT, DELETE 를 사용해서 CRUD 를 나타내며 메시지에 Status Code 도 담겨 반환된다. 성숙도 2 단계에서 GET 은 상태를 변화시키지 않는 안전한 Action이 된다. GET 은 안전하게 어떤 순서로든 얼마든지 호출할 수 있고, 매번 같은 결과(멱등성)를 얻도록 한다. 즉, Cache 를 적용해서 사용자 입장에서 성능 향상을 느낄 수 있다.

 

서비스는 HTTP 동사를 이용해서 액션을 수행하고(예: GET은 조회, POST는 생성, PUT은 수정), 요청 쿼리 매개변수 및 본문, 필요 시 매개변수를 지정한다. 덕분에 서비스는 GET 요청을 캐싱하는 등 웹 인프라를 활용할 수 있다.

 

성숙도 2 단계에서는 더 이상 URI 에 action 이 담기지 않는다. 그리고 멱등성을 보장하는 GET 에는 Cache 가 적용되며, Response 에 HTTP Status Code 가 의미있게 반환된다. HTTP Status Code 를 모두 활용할 필요는 없다.

클라이언트 개발자의 입장에서 자신의 요청이 성공(200 OK) 인지 실패인지만 알고 싶어하는 경우가 많다.

실패라면 클라이언트 잘못(400 Bad Request) 인지 서버 잘못(500 Internal Server Error) 정도면 충분하다고 한다. 다만, 실패라면 Body 에 왜 실패했는지에 대한 정보를 보내 주는 것이 좋다.

 

 

 

- 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(READ)하는 행위

➥ 조회(READ)하기 위해서는 GET 메서드를 사용하여 요청한다. 

(이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다.)

 

- 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)한다는 것

➥ 예약을 생성(CREATE)하기 위해서는 POST 메서드를 사용하여 요청한다. 

(POST 요청에 대한 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created 로 명확하게 작성해야 한다.

그리고 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 한다. )

 

---

<HTTP 메서드 사용 규칙>

 

• GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
• POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 한다.
• PUT 메서드와 PATCH 메서드도 구분하여 사용해야 한다. PUT은 교체, PATCH는 수정의 용도로 사용한다.

 

👉 API를 작성할 때, REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다.

로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한 API는 REST API가 아닌 HTTP API라고 불러야 한다고 주장하지만, 모범적인 API 디자인이라고 하는 것도 REST 성숙도 모델의 3단계까지 적용한 경우는 드물다고 한다.

그래서 3단계까지 무조건적으로 모두 적용해야 하는 것은 아니다.

 

 

HTTP API

 

 

<HTTP API 디자인을 잘 하기 위해 꼭 기억해야 할 5가지 메서드>

2022.06.09 - [네트워크] - TIL) 웹 애플리케이션 아키텍처, API, 클라이언트와 서버의 통신, HTTP, 프로토콜이란?

 

---

REST 성숙도 모델 - 3단계

 

HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 

3단계의 요청은 2단계와 동일하지만, 응답에 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.

이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

 

서비스를 HATEOAS(Hypertext As The Engine Of Application State, 애플리케이션 상태 엔진으로서의 하이퍼미디어) 원칙에 기반하여 설계한다. HATEOAS는 GET 요청으로 반환된 리소스 표현형에 그 리소스에 대한 액션의 링크도 함께 보내는 것이다. 가령 클라이언트는 GET 요청으로 주문 데이터를 조회하고 이때 반환된 표현형 내부 링크를 이용해서 해당 주문을 취소할 수도 있습니다. HATEOAS를 사용하면 하드 코딩한 URL을 클라이언트 코드에 욱여넣지 않아도 된다고 한다. 

 

 

➥허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다. 이렇게 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심 포인트입니다.

만약 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있습니다.

 

 

REST를 구성하는 스타일

- client-server

- stateless

- cache

- uniform interface

- layered system

- code-on-demand (optional)

 

상호운용성(interoperability)에 대한 집착

- Referer 오타지만 안 고침

- charset 잘못 지은 이름이지만 안 고침

- HTTP 상태 코드 416 포기함 (I'm a teapot)

- HTTP/0.9 아직도 지원함 (크롬, 파이어폭스)

 

무조건 REST를 써야하는가?

시스템 전체를 통제할 수 있다고 생각하거나, 진화에 관심이 없다면 REST에 대해 따지느라 시간낭비하지 마라. -by Roy Fielding

 

---

참고)

 

2022.06.09 - [네트워크] - TIL) 웹 애플리케이션 아키텍처, API, 클라이언트와 서버의 통신, HTTP, 프로토콜이란?

 

https://bentist.tistory.com/37

 

https://ohjongsung.io/2018/07/21/rest-api-%EC%84%B1%EC%88%99%EB%8F%84-%EB%AA%A8%EB%8D%B8-maturity-model

 

https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md

 

https://cloud.google.com/apis/design/resources?hl=ko

 

 

 

😃 잘못된 개념 전달이 있다면 댓글 부탁드립니다. 저의 성장에 큰 도움이 됩니다🤓