[HTTP/네트워크] 실습

REST API 

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

 

리처드슨의 REST 성숙도 모델 구조화

➡️ 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다. 실제로 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 할 수 있고 이 경우를 HTTP API라고 부른다.

---

REST 성숙도 모델 - 0단계

➡️ HTTP 프로토콜을 사용하기만 해도 된다. 이 경우엔 REST API라고 할 수는 없고 작성하기 위한 기본단계이다.

예를 들면,

허준이라는 주치의의 예약 가능한 시간을 확인하고 어떤 특정 시간에 예약하는 상황이라고 할 때 HTTP 프로토콜을 사용하는 것을 확인할 수 있다. 

---

REST 성숙도 모델 - 1단계

➡️ 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다. REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현하는데 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용하고 요청하여 받는 자원에 대한 정보를 응답으로 전달하는 것이 1단계 핵심이다. 0단계 요청에서는 엔드포인트로 모두 /appointment를 사용했다.

요청의 응답으로 받는 자원은 허준이 예약 가능한 시간대이다. 엔드포인트는 /doctors/허준을 사용했다. 특정 시간에 예약하게 되면 실제 slots라는 리소스의 123이라는 Id를 가진 리소스가 변경되면서 특정 시간에 예약 요청은 /slots/123으로 변경되는 리소스를 엔드포인트로 사용했다. 

 

➡️ 엔드포인트는 리소스를 변화시키거나 응답이 제공되는지에 따라 적절한 엔드포인트를 작성하는 것이 중요함

작성시에는 동사, HTTP 메서드, 어떤 행위에 대한 사용은 지양, 리소스에 집중해 명사 형태의 단어로 작성

 

요청에 따른 응답을 리소스로 전달할 때 성공/실패 여부를 반환해야 함. 위의 예시는 리소스 사용에 대한 실패 여부를 포함한 응답을 받아야 한다.

---

REST 성숙도 모델 - 2단계

➡️ CRUD(Create, Read, Update, Delete) 맞게 적절한 HTTP 메서드를 사용해야함. 1단계에서는 모든 요청을 CRUD와 상관없이 POST 메서드를 사용했는데 2단계에서는 적합한 메서드를 사용한 것이 아니다.

예약 가능한 시간을 조회(READ)하는 행위, 특정 시간에 예약을 생성(CREATE)하는 것과 같다. 조회하기 위해서는 GET 메서드를 사용하여 요청을 보내고, body를 가지지 않기 때문 query parameter를 사용하여 필요한 리소스를 전달한다. 생성(CREATE)하기 위해서 POST 메서드를 사용하여 요청하고 응답 코드는 201 Created로 명확하게 작성해야하며, 관련 리소스 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 2단계 충족한 것이다.

 

※ HTTP 메서드를 사용할 때 유의할 점

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

2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다. 로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한 API는 REST API가 아닌 HTTP API라고 불러야 한다고 주장하지만, 3단계는 무조건적으로 모두 적용해야 하는 것은 아니다.

---

REST 성숙도 모델 - 3단계

➡️ HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야한다. 응답을 받은 다음 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

허준의 예약가능 시간을 확인 후 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 완료후 예약을 다시 할 수 있도록 링크를 작성할 수 있다. 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계 핵심

---

Open API

➡️ 공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있다. 누구나 열려있지만 무제한으로 이용할 수 있는 건 아니고 API마다 정해진 이용 수칙이 있으며 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다. 데이터를 JSON 형태로 응답하며, 제한적이나마 무료로 날씨 API를 사용할 수 있다.

 

API Key

➡️ API를 이용하기 위해서는 API Key가 필요하다. 서버의 문을 여는 열쇠며 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 조건 없이 클라이언트에게 데이터를 제공할 의무는 없다. 필요한 경우 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하며 데이터 요청할 때 API KEY를 같이 전달해야 원하는 응답을 받을 수 있다.