DevOps12일차 - 발표과제, REST API

발표자료

HTTP구조, 요청과 응답 헤더등 유추할 수 있는 내용을 모두 작성

• Request URL = 클라이언트가 요청하는 리소스의 위치를 나타냅니다.

• Request Method = 클라이언트가 서버에게 요청을 보내는 방법을 나타냅니다. GET, POST, PUT, DELETE 등이 있습니다.

• Status code = 서버가 클라이언트에게 응답하는 HTTP 응답 코드입니다. 200, 404, 500 등이 있습니다.

• remote Adress = 클라이언트가 요청을 보내는 서버의 IP 주소입니다.

• Referer Policy = 웹 페이지에서 리소스를 가져올 때 브라우저가 어떻게 동작해야 하는지를 나타냅니다.

  • 이 정보는 웹 개발자가 웹 애플리케이션을 디버깅하고 문제를 해결하는 데 도움이 됩니다.
  • strict-origin-when-cross-origin은 다른 도메인에서 가져온 리소스에 대해 Referer 헤더를 보내지 않는 것을 의미합니다. 이는 보안상의 이유로 사용됩니다.

• connection: keep-alive = keep-alive는 HTTP 연결을 유지하는 방법 중 하나입니다. 이 방법을 사용하면 클라이언트와 서버 간의 연결을 유지하고 다음 요청에 대한 대기 시간을 줄일 수 있습니다. 이를 통해 웹 페이지 로드 속도가 빨라집니다.

• content-encoding : gzip = gzip은 HTTP 응답에서 데이터를 압축하는 데 사용되는 알고리즘입니다. 이를 통해 데이터 전송 속도를 높일 수 있습니다. 브라우저는 이 데이터를 수신하고 압축을 해제하여 사용자에게 표시합니다.

• Content-type : text/html; charset=utf-8 = Content-type은 HTTP 응답에서 전송되는 데이터의 유형을 나타냅니다. text/html은 HTML 문서를 나타내며, charset=utf-8은 문자 인코딩을 나타냅니다. 이 정보는 브라우저가 데이터를 올바르게 해석하고 표시할 수 있도록 도와줍니다.

• Date: Thu, 27 Jan 2022 03:17:53 GMT = Date는 HTTP 응답이 생성된 날짜와 시간을 나타냅니다. 이 정보는 브라우저가 캐시된 데이터를 올바르게 처리하고 새로운 데이터를 가져와야 하는지 여부를 결정하는 데 사용됩니다.

• Keep-Alive: timeout=60 = Keep-Alive는 HTTP 연결을 유지하는 방법 중 하나입니다. timeout=60은 서버가 클라이언트와의 연결을 유지하는 시간을 나타냅니다. 이 경우 60초 동안 연결이 유지됩니다. 이를 통해 다음 요청에 대한 대기 시간을 줄일 수 있습니다. 이를 통해 웹 페이지 로드 속도가 빨라집니다.

• Transfer-Encoding: chunked = chunked는 HTTP 1.1 버전에서 사용 가능한 스트리밍 데이터 전송 방식입니다. 이 방식에서 데이터는 각각의 덩어리들로 나누어져 전송됩니다.

• x-envoy-upstream-service-time : 8 = x-envoy-upstream-service-time 헤더는 Envoy 프록시에서 사용되는 헤더입니다. 이 헤더는 요청을 처리하는 데 걸린 시간과 Envoy와 upstream 호스트 간의 네트워크 지연 시간을 포함합니다.

• X-Frame-options : SAMEORIGIN = 해당 페이지를 포함하고 있는 웹 페이지와 같은 출처에서만 해당 페이지를 렌더링할 수 있도록 허용하는 옵션입니다. 이 옵션을 사용하면 해당 페이지가 다른 도메인에서 iframe으로 렌더링되는 것을 방지할 수 있습니다.

• Accept = 클라이언트가 선호하는 미디어 타입 전달

• Accept-Encoding = 클라이언트가 선호하는 압축 인코딩

• Accept-Language = 클라이언트가 선호하는 자연언어, 1순위 ko 2순위 en-US 3순위 en

• Host: toss.im = Host 헤더는 클라이언트가 요청하는 서버의 호스트 이름을 나타냅니다.

  • toss.im은 모바일 금융 플랫폼입니다. 이 플랫폼은 사용자들이 간편하게 송금, 결제, 대출 등의 금융 서비스를 이용할 수 있도록 도와줍니다.

• Pragma: no-cache = Pragma 헤더는 HTTP/1.0에서 사용되었던 캐시 제어 헤더입니다. 이 헤더는 캐시된 문서를 사용하지 않고, 원 서버에서 문서를 가져와야 함을 나타냅니다.

• sec-ch-ua = Sec-CH-UA 헤더는 브라우저의 브랜드와 버전 정보를 제공합니다.

• sec-ch-ua-mobile = Sec-CH-UA-Mobile 헤더는 브라우저가 모바일 장치에 있는지 여부를 나타냅니다.

REST API

REST API를 작성할 때는 몇 가지 지켜야 할 규칙들이 있습니다. 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨은 REST API를 잘 적용하기 위한 4단계 모델을 만들었습니다.

리차드슨의 REST 성숙도 모델을 구조화하면 다음과 같습니다.

REST 성숙도 모델은 총 4단계(0~3단계)로 나누어집니다.

앞서 이야기한 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했습니다. 그러나 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우 HTTP API 라고도 부릅니다.

REST 성숙도 모델 - 0단계

REST 성숙도 모델에 따르면, 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 됩니다. 물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 좋은 REST API를 작성하기 위한 기본 단계입니다.

허준이라는 이름의 주치의의 예약 가능한 시간을 확인하고, 어떤 특정 시간에 예약하는 상황을 예로 들어 보겠습니다.

위 예시에서는 HTTP 프로토콜을 사용하고 있는 것을 확인 할 수 있습니다. 이렇듯 단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점입니다.

혹시 위 예시의 REST API가 적절하지 않다고 생각한다면, 어느 부분이며 왜 그런지 고민해보세요.

REST 성숙도 모델 - 1단계

REST 성숙도 모델 1단계를 설명하고 나면 앞서 0단계에서 들었던 API 예시를 조금 더 적절하게 바꿀 수 있을 겁니다. REST 성숙도 모델에 따르면, 1단계에서는 개별 리소스와의 통신을 준수해야 한다고 합니다.

조금 더 쉽게 말하면, 앞서 REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현한다고 이야기했습니다. 그래서 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바입니다.

앞서 0단계에서는 모든 요청에서 엔드포인트로 /appointment를 사용하였습니다. 하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용해야 합니다. 다음 예시를 보겠습니다.

위의 예시에서 예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원(리소스)은 허준이라는 의사의 예약 가능한 시간대입니다. 그렇기 때문에 요청 시 /doctors/허준이라는 엔드포인트를 사용한 것을 볼 수 있습니다. 뿐만 아니라, 특정 시간에 예약하게 되면, 실제 slot이라는 리소스의 123이라는 id를 가진 리소스가 변경되기 때문에, 하단의 특정 시간에 예약이라는 요청에서는 /slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용하였습니다.

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

더불어 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 합니다. 예를 들어 만약 김코딩 환자가 허준 의사에게 9시에 예약을 진행하였으나, 해당 시간이 마감되어 예약이 불가능하다고 가정할 때, 아래와 같이 리소스 사용에 대한 실패 여부를 포함한 응답을 받아야 합니다.

REST 성숙도 모델 - 2단계

REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점을 둡니다. 앞서 0단계와 1단계 예시에서 보았듯, 모든 요청을 CRUD에 상관없이 POST로 하고 있습니다. 그러나 REST 성숙도 모델 2단계에 따르면 이는 CRUD에 따른 적합한 메소드를 사용한 것은 아닙니다.

먼저 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(READ)하는 행위를 의미하고, 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)한다는 것과 같습니다. 그렇기 때문에 조회(READ)하기 위해서는 GET 메소드를 사용하여 요청을 보내고, 이때 GET 메소드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달합니다.

또한 예약을 생성(CREATE)하기 위해서는 POST 메소드를 사용하여 요청을 보내는 것이 바람직합니다. 그리고 2단계에서는 POST 요청에 대한 응답이 어떻게 반환되는지도 중요합니다.

이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created 로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인 할 수 있도록 해야, 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있습니다.

물론 메소드를 사용할 때도 규칙이 있습니다.

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

더 자세한 내용을 학습하고 싶다면 MDN HTTP request methods 를 읽어보기 바랍니다.

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용을 하면 대체적으로 잘 작성된 API라고 여깁니다. 물론 로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한다면 REST API가 아니기 때문에 HTTP API라고 불러야 한다고 주장하지만, 뒤에 만나게 되는 레퍼런스의 모범적인 API 디자인조차도 REST 성숙도 모델의 3단계까지 적용한 경우는 극히 드뭅니다. 따라서 3단계까지 무조건적으로 모두 적용해야 한다는 것은 아닙니다.

REST 성숙도 모델 - 3단계

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

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

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

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

이렇게 리차드슨의 REST 성숙도 모델을 통해 좋은 REST API를 작성하기 위한 규칙에 대해서 알아보았습니다. 규칙들을 통해 리소스 중심의 올바른 엔드포인트 작성, 적절한 응답 코드와 리소스에 대한 정보 기재, CRUD에 적합한 HTTP 메소드 사용 등을 고려해야 좋은 REST API를 디자인 할 수 있다는 것을 배웠습니다.