[HTTP]REST API

• REST API에 대해 이해할 수 있다.

REST API란 웹 애플리케이션에서는 HTTP메서드를 이용해 서버와 통신한다 GET을 통해 웹 페이지나 데이터를 요청하고, POST로 새로운 글이나 데이터를 전송하거나 DELETE로 저장된 글이나 데이터를 삭제할 수 있다. 이처럼 클라이언트와 서버가 HTTP통신을 할 때는 어떤 요청을 보내고 받느냐에 따라 메서드의 사용이 달라진다

요청과 응답을 할 때, 제대로 보내고 받을 수 있는 약속이 존재한다

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

클라이언트와 서버 사이에도 데이터와 리소스를 요청하고 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다 이 메뉴판을 보고 클라이언트는 식당에서 식사를 주문하듯 서버에 요청하고, 이에 대한 응답을 메뉴판에 있는 사진이나 음식에 대한 설명처럼 다시 서버에서 클라이언트로 전송하게 된다

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

좋은 REST API를 디자인하는 방법

REST API를 작성할 때 규칙이 있다 

REST 성숙도 모델은 총 4단계(0~3단계)로 나누어진다 모든 단계를 충족 해야 REST API라고 부를수 있다. 그러나 실제로 3단계까지 지키기 어렵기 때문에 2단계까지만 해도 좋은 API디자인이라 볼수 있고 이런경우 HTTP API라고도 부른다

REST 성숙도 모델 -0단계

REST 성숙도 모델에 따르면 0단계에서는 단순히 HTTP 프로토콜을 사용하기만해도된다 

 

REST 성숙도 모델 -1단계

REST 성숙도 모델에 따르면 1단계에서는 개별 리소스와 통신을 준수해야한다.

앞서 REST API는 웹에서 사용되는 모든 데이터나 자원을 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로 했다 그러나 2단계에 따르면 적합한 메서드가 아니다

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

또한 생성하기위해선 post메서드를 사용해서 요청을 보내고 그에대한 응답이 어떻게 반환되는지 중요하다

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

메서드를 사용할 때도 규칙이 있다

-get 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용해야한다

-post는 요청마다 새로운 리소스를 생성하고 put은 요청마다 같은 리소스를 반환한다 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등이라고 한다 그래서 멱등성을 가지는 메서드 put과 그렇지 않은 post는 구분해서 사용해야한다

-put과 patch도 구분해서 사용해야한다 put은 교체, patch는 수정의 용도로 사용한다 

REST 성숙도 모델 -3단계

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

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

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

이렇게 응답내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트이다

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

• Open API와 API Key에 대해 이해할 수 있다.

정부에서 제공하는 공공데이터가 있다 공공데이터에 쉽게 접근 할 수 있도록 정부는 오픈 API의 형태로 공공데이터를 제공한다

이 API에는 OPEN이라는 키워드가 붙어있다 글자그대로 누구에게나 열려있지만 무제한으로 이용할 수 있는것은 아니다 기관이나 API마다 정해진 이용수칙이 있고 그 이용수칙에 따라 제한사항(가격,정보의 제한 등)이 있을 수있다

API Key

API를 이용하려면 API key가필요하다 클라이언트의 요청에 따라 서버에서 응답한다는 말은 결국 서버를 운용하는데 비용이 발생한다는 말이다 다라서 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무도 이유도 없다.그래서 로그인된 이용자에게만 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야만 원하는 응답을 받을 수 있다.

 

동적 데이터조회

주로 검색, 게시판 목록에서 정렬 필터(검색어)

조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용

GET은 쿼리 파라미터 사용해서 데이터를 전달