옥수수, 기록
REST API와 성숙도 모델 본문
REST API
REST(Representational State Transfer)
REST API란
웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식
REST API 디자인의 필요성
손님이 식당에 들어가 주문할 때, 메뉴판을 보고 주문하듯 클라이언트도 서버 사이에도 API라는 메뉴판이 필요하다. 하지만 메뉴판이 복잡하게 되어있다면 알아보기도 힘들고 주문하는데 애를 먹을 것이다.
HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알잘딱한 메뉴판이 필요하다.
REST API 디자인
작성할 때 몇 가지 지켜야 할 규칙들이 있는데 레오나르드 리차드슨(Leonard Richardson)이 로이 필딩이 논문에서 제시한 ‘REST 방법론’을 보다 실용적으로 적용하기위해 ‘REST API를 잘 적용하기 위한 4단계 모델’ 을 만들었다.
로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했지만 3단계까지는 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고 이런 경우를 HTTP API라고 부른다.
REST 성숙도 모델 0단계 - HTTP 사용
성숙도 모델에 따르면 0단계에서는 단순히 HTTP 프로토콜만 사용해도 된다.
물론 이 경우 이 API는 REST API라고 할 수 없으며, 0단계는 REST API를 작성하기 위한 기본 단계이다.
| 요청내용 | 요청 | 응답 |
| 예약 가능한 시간 확인 | POST /appointment HTTP/1.1 [헤더 생략] { “date”: “2022-12-03”, ”designer”: “다잘라” } |
HTTP/1.1 200 OK [헤더 생략] { “slots”: [ { ”designer”: “다잘라”, “start”: “11:00”, “end”: “11:30” }, { ”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, ] } |
| 특정 시간에 예약 | POST /appointment HTTP/1.1 [헤더 생략] { ”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30”, client”: “옥수수” } |
HTTP/1.1 200 OK [헤더 생략] |
REST 성숙도 모델 1단계 - 개별 리소스와의 통신 준수
REST API는 웹에서 사용되는 모든 데이터나 자원(Resourse)를 HTTP URI로 표현한다.
따라서 모든 자원은 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다.
0단계에서는 요청에서 엔드로인트로 모두 /appointment를 사용하였지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용한다.
| 요청내용 | 요청 | 응답 |
| 예약 가능한 시간 확인 | POST /designer/다잘라 HTTP/1.1 [헤더 생략] { “date”: “2022-12-03” } |
HTTP/1.1 200 OK [헤더 생략] { “slots”: [ { ”id”: 1, ”designer”: “다잘라”, “star. t”: “11:00”, “end”: “11:30” }, { ”id”: 11”designer”: “다잘라”, “star t”: “19:00”, “end”: “19:30” }, ] } |
| 특정 시간에 예약 | POST /slots/11 HTTP/1.1 [헤더 생략] { “client”: “옥수수” } |
HTTP/1.1 200 OK [헤더 생략] { “appointment”: { “slot”: { ”id”: 11”desi gner”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, “client”: “옥수수” } } |
위의 예시에서 예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원(리소스)은 ‘다잘라’라는 디자이너의 예약 가능한 시간대이다. 그렇기 때문에 요청 시 /designer/다잘라 라는 엔드포인트를 사용한 것을 볼 수 있다. 그뿐만 아니라, 특정 시간에 예약하게 되면, 실제 slots라는 리소스의 11이라는 id를 가진 리소스가 변경되기 때문에, 하단의 특정 시간에 예약이라는 요청에서는 /slots/11 로 실제 변경되는 리소스를 엔드포인트로 사용하였다.
이와 같이 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요하다.
엔드포인트 작성시 : 동사, HTTP 메서드, 어떤 행위에 대한 단어 사용 지양 > 리소스에 집중해 명사 형태의 단어로 작성하는 것이 좋음
아래는 예약이 불가능할 때 리소스 사용에 대한 실패 여부를 포함한 응답의 예이다.
요청내용 요청 응답
| 요청내용 | 요청 | 응답 |
| 예약 가능한 시간 확인 | POST /designer/다잘라 HTTP/1.1 [헤더 생략] { “date”: “2022-12-03” } |
HTTP/1.1 200 OK [헤더 생략] { “slots”: [ { ”id”: 1, ”designer”: “다잘라”, “start”: “11:00”, “end”: “11:30” }, { ”id”: 11”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, ] } |
| 특정 시간에 예약 | POST /slots/11 HTTP/1.1 [헤더 생략] { “client”: “옥수수” } |
HTTP/1.1 200 OK [헤더 생략] { “appointmentFailure”: { “slot”: { ”id”: 11”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, “client”: “옥수수” “reason: “해당 시간은 이미 예약중입니다” } } |
REST 성숙도 모델 2단계 - HTTP 메소드 원칙 준수
0,1 단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메소드를 사용하고 있다. 그러나 2단계에 따르면 이는 적합한 메소드를 사용한 것이 아니다.
READ: 예약 가능한 시간을 확인한다 > 조회(READ)하는 행위를 의미
>> GET 메소드를 사용해 요청을 보내고 GET 메소드는 body를 가지지 않기 때문에 query parameter를 사용해 필요한 리소스를 전달한다.
CREATE: 특정 시간 예약 > 예약 생성(CREATE)를 의미
>> POST 메소드를 사용해 요청을 보내고 POST요청에 대한 응답이 어떻게 반환되는지가 중요하다.
이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created로 명확하게 작성하고 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 2단계를 충족한 것이라 볼 수 있다.
| 요청내용 | 요청 | 응답 |
| 예약 가능한 시간 확인 | POST /designer/다잘라/slots?date=2022-12-03 HTTP/1.1 [헤더 생략] |
HTTP/1.1 200 OK [헤더 생략] { “slots”: [ { ”id”: 1, ”designer”: “다잘라”, “start”: “11:00”, “end”: “11:30” }, { ”id”: 11”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, ] } |
| 특정 시간에 예약 | POST /slots/11 HTTP/1.1 [헤더 생략] { “client”: “옥수수” } |
HTTP/1.1 201 Created [헤더 생략] { “appointment”: { “slot”: { ”id”: 11”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, “client”: “옥수수” } } |
GET은 정보를 조회할 수 있음
>> GET 메서드를 사용할 때는 query parameter를 사용해 정보를 조회하고 path parameter에는 보통 id를 집어넣어 특정한 리소스 의 정보를 조회하는 경우가 많다.
HEAD는 header만 조회할 수 있음
PUT은 해당 리소스를 완전히 바꿈
PATCH는 해당 리소스를 조금 바꿈
POST는 리소스를 생성
HTTP 메소드를 사용할 때 지켜야할 규칙
- GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
- POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 한다.
- PUT 메서드와 PATCH 메서드도 구분하여 사용해야 한다. PUT은 교체, PATCH는 수정의 용도로 사용한다.
- URI에 메서드가 들어가지 않는다.
- URI 작성시 spinal-case 사용
REST 성숙도 모델 3단계 - HATEOS 원칙준수
마지막 3단계는 HATEOAS(Hypermedia As The Engine Of Application State)라고 불리는 하이퍼미디어 컨트롤을 적용해야 한다. 요청은 2단계와 동일하지만 응답에 리소스의 URI를 포함한 링크 요소를 삽입해 작성해야 한다.
응답에 들어가는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.
| 요청내용 | 요청 | 응답 |
| 예약 가능한 시간 확인 | POST /designer/다잘라/slots?date=2022-12-03 HTTP/1.1 [헤더 생략] |
HTTP/1.1 200 OK [헤더 생략] { “slots”: [ { ”id”: 1, ”designer”: “다잘라”, “start”: “11:00”, “end”: “11:30” }, { ”id”: 11”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, ] } |
| 특정 시간에 예약 | POST /slots/11 HTTP/1.1 [헤더 생략] { “client”: “옥수수” } |
HTTP/1.1 201 Created [헤더 생략] { “appointment”: { “slot”: { ”id”: 11”designer”: “다잘라”, “start”: “19:00”, “end”: “19:30” }, “client”: “옥수수”, “links” : { “self”: { “href”: “http://localhost:3000/slots/11”, “method”: “GET” }, “cancel”: { “href”: “http://localhost:3000/slots/11/”, “method”: “DELETE” } } } |
위와 같이 다잘라 디자이너의 예약 가능 시간을 확인한 후 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다.
이렇게 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심이다.
Rest API에 대해 참고하면 좋은 글
https://blog.restcase.com/5-basic-rest-api-design-guidelines/
https://cloud.google.com/apis/design/resources?hl=ko
Open API
정부에서 제공하는 공공데이터 포털이라는 공공데이터를 제공하는 Open API 제공 사이트가 있는데 여기서 Open API는 누구에게나 열려있는 API를 뜻한다.
** Open이라고 하여 무료로, 무제한으로 이용 가능하다는 의미는 아니다. API마다 정해진 이용 수칙이 있고, 이용 수칙에 따라 제한사항(가격, 정보제한)이 있을 수 있다.
API KEY
API를 이용하기 위해서는 API Key가 필요하다. API key는 서버의 문을 여는 열쇠로 서버를 운용하는데는 비용이 발생하기 때문에 익명의 클라이언트에게 데이터제공을 방지하는 역할을 한다.