[네트워크] HTTP

Rest API

웹 애플리케이션에서는 HTTP 메서드를 이용해 서버와 통신합니다.

HTTP 메서드를 사용해 요청과 응답을 할 때 제대로 보내고 받을 수 있는 일종의 규약이 존재하는데 이것을 REST API라고 합니다.

 

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

아래는 리차드슨의 REST 성숙도 모델을 구조화한 것입니다.

총 4단계(0단계~3단계)로 나누어지는데 실제로는 2단계가지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우 HTTP API라고 부릅니다.

 

• 0단계 - HTTP 사용

단순히 HTTP 프로토콜을 사용하는 것입니다. 물론 이 경우, 해당 API를 REST API라고 할 수는 없으며 좋은 REST API를 작성하기 위한 기본 단계입니다.

• 1단계 - 개별 리소스와의 통신 준수

앞서 REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)를 HTTP URI로 표현한다고 설명했습니다.

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

 

0단계에서는 모든 요청에서 엔드포인트로 /appointment 를 사용했습니다.

하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용해야 합니다.

예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원은 허준이라는 의사의 예약 가능한 시간대이기 때문에 요청 시 /doctors/허준 이라는 엔드포인트를 사용했습니다.

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

이와 같이 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에 적절한 엔드포인드를 작성하는 것이 중요합니다.

 

💡 동사, HTTP 메서드, 어떤 행위에 대한 단어 사용은 지양하고 명사 형태의 단어로 작성해야 한다.

응답할 때 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

• 2단계 - HTTP 메서드 원칙 준수

0단계와 1단계는 모든 요청을 CRUD에 상관 없이 POST로 하고 있습니다.

예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(READ)하는 행위를 의미하고, 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)한다는 것과 같습니다.

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

예약을 생성(CREATE)하기 위해서는 POST 메서드를 사용하여 요청을 보내야 하고 POST 요청에 대한 응답이 어떻게 반환되는지도 중요합니다.

💡 GET 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다. POST는 요청마다 새로운 리소스를 생성하고 PUT은 요청마다 같은 리소스를 반환해야 한다.

• 3단계 - HATEOAS 원칙 준수

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

2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 다릅니다.

Open API와 API Key

정부에서 제공하는 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있습니다.

글자 그대로 누구에게나 열려있는 API지만 “무제한으로 이용할 수 있다”라는 의미는 아닙니다.

기관이나 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항이 있을 수 있습니다.

 

API를 이용하기 위해서는 API Key가 필요합니다.

서버를 운용하는 데에 비용이 발생하기 때문에 로그인 된 이용자에게만 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야만 원하는 응답을 받을 수 있습니다.