REST API

oscar0421·2022년 6월 10일
0
post-thumbnail

들어가기

REST API에서 REST는 “Representational State Transfer”의 약자로 로이 필딩 (Roy Fielding)의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었다.

이번 블로깅에서는 REST API가 무엇이며, 사용방법은 어떻게 되는지 정리해보려고 한다.

REST API

REST API 디자인

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

HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽게 작성된 일종의 메뉴판이 필요하며 이 역할을 API가 수행한다.

알아보기 쉬운 메뉴판 작성을 위해 다음의 4단계 모델을 제시했다.

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜만 사용해도 된다. 하지만 이경우 REST API라고 할 수는 없으며, REST API작성을 위한 준비단계라고 생각해도 좋다.

REST 성숙도 모델 - 1단계

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

엔드포인트 작성 시에는 동사, HTTP 메서드 등은 지양하고, 리소스에 집중하여 명사 형태의 단어로 작성하는 것이 바람직한 방법이다. 또한, 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

예시) POST /doctors/허준

REST 성숙도 모델 - 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 앞서 0단계와 1단계에서는 모든 요청을 CRUD와 상관없이 POST 메서드를 사용했다. 그러나 2단계에 따르면, 이는 CRUD에 따른 적합한 메서드를 사용한 것이 아니다.

  • 조회 등 데이터를 읽는 요청(READ) GET메소드를 사용
  • 새로운 데이터를 삽입하는 요청(CREATE) POST메소드를 사용. 반환되는 응답코드가 201이라면 성공.
  • 데이터의 수정을 요청(UPDATE) PUT혹은 PATCH메소드를 사용. PUT은 교체, PATCH는 수정
  • 데이터의 삭제를 요청(DELETE)

POST메소드는 요청마다 새로운 리소스를 생성하고, PUT메소드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등성이라고 한다.

REST 성숙도 모델 - 3단계

마지막 단계는 HATEOAS로 불리는 하이퍼미디어 컨트롤을 적용합니다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.

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

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

Open API와 API Key

REST API의 동작이 궁금하다면 다음 사이트를 참고해보자.

  • 공공데이터 포탈
    정부에서 제공하는 공공데이터이며 OPEN API다. OPEN이라는 키워드에서 볼 수 있듯 누구에게나 열려있다. 다만 API에 따라 이용수칙이 있을 수 있다. 응답 데이터의 API마다 다르다. JOSN XML CSV 등등.
  • Open Weather Map
    날씨정보를 제공하는 API다. 프리플랜으로 무료로 사용해볼 수 있다. 다만, 분당 60번 한달 100번의 호출이 가능하다. 응답 데이터는 JSON이다.

마치며.

이번 REST API 블로깅을 통해 클라이언트와 서버 간의 통신을 조금더 이해하게 된 것 같다.

또한, REST API를 이용하여 웹 사이트를 만들어볼 생각을 하니 벌써 흥미롭다. 이번 블로깅을 마치면, 한번 시도해볼 생각이다.

더 멋진 개발자가 될 때까지 화이팅!

profile
아기코린이

0개의 댓글