REST API

남성윤·2022년 8월 5일
0

Code States 학습

목록 보기
27/66

REST API 에서의 REST는 "Representational State Transfer"의 약자로, 웹의 장점을 최대한 활용할 수 있는 아키텍쳐로 소개되었다.

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

이 REST API를 잘 작성해야 HTTP 프로토콜을 기반으로 리소스를 주고받기가 쉬워진다.

REST 성숙도 모델에서는 기본적으로 3단계까지 지키기도 쉽지 않기 때문에, 2단계까지만 적용하더라도 좋은 API디자인이라고 볼 수 있고, 이런 경우를 HTTP API라고도 부른다.

0단계, 시작점은 HTTP프로토콜을 사용하는 것이다.
그저 HTTP프로토콜을 사용하는것만으로도 REST API의 출발점에 섰다고 말할 수 있겠다.

1단계, 개별 리소스와의 통신을 준수하는것이다.
모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야하며, 요청하고 받는 자원에 대한 정보를 응답으로 전달해야한다는 것이다.

2단계, CRUD에 맞게 적절한 HTTP메서드를 사용하는 것이다.

HTTP 메서드를 사용할 때 몇가지 규칙에도 유의하셔야 합니다.

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

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

OPEN API
OPEN이라는 키워드가 붙은만큼, 누구에게나 열려있는 API이지만, 무제한으로 이용할 수 있다는 의미는 아니다. API마다 정해진 이용 수칙이 있고. 이용 수칙에 따라 제한사항이 있을 수 있다.

API를 이용하기 위해서는 API Key가 필요한 경우가 있다. API Key는 서버의 문을 여는 열쇠로, 서버를 운영하는데 비용이 발생하기 때문에 아무런 조건 없이 클라이언트에게 데이터를 제공할 의무가 있는것은 아니다. 이런 경우 권한을 API Key로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받는 형식을 사용하기도 한다.

profile
안녕하세요, Blog 2022.06 ~

0개의 댓글