[네트워크] REST API

정동아·2023년 5월 23일

백엔드 부트캠프

목록 보기

29/41

개발 공부를 시작하기 전에도 REST API에 대해선 많이 들어본적이 있다. ~~(물론 그냥 듣기만..)~~
처음 API를 학습할 때에는 이게뭔가.. 싶었는데, 여러번 보고 여러번 실습해보니 이젠 어떤 개념이고 뭘하는지 이해가 되어서 기분 좋음 + 의욕 추가가 되었다.

웹 애플리케이션에서는 HTTP 메서드를 이용해서 서버와 통신한다. 클라와 서버가 HTTP통신을 할 때 어떤 요청을 보내고 받느냐에 따라 메서드의 사용이 달라지는데, 예를 들면 GET을 통해 웹 페이지나 데이터를 요청하거나, POST를 이용해서 새로운 글이나 데이터를 전송한다.

REST API란?

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

HTTP 프로토콜 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 서로 잘 알아볼 수 있도록 API를 작성하는게 중욯ㄴ다.

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

REST API를 작성할 때는 몇가지 지켜야하는 규칙이 있다. 리처드슨의 REST 성숙고 모델을 구조화하면 아래 이미지와 같다.

REST 성숙도 모델은 총 4단계로 나워지는데, 3단계까지 지키는건 어려워서 2단계까지만 적용해도 좋은 API디자인이라고 볼 수 있고, 이런 경우 HTTP API라고 부른다.

1) 0단계
REST 성숙도 모델에 따르면 단순하게 HTTP 프로토콜을 사용하기만 해도 된다. (좋은 REST API를 작성하기위한 기본단계!)

2) 1단계
1단계에서는 개별 리소스와의 통신을 준수해야한다.
정리하면, 모든 자원은 개별 리소스에 맞는 엔드포인드를 사용해야하고, 요청하고 받은 자원에 대한 정보를 응답으로 전달해야한다.
엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직하다.
또한, 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 같이 반환해야한다.

3) 2단계
2단계는 CRUD에 맞는 적절한 HTTP메서드를 사용하는 것에 중점을 둔다.

get메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용
post는 요청마다 새로운 리소스를 생성하고, put은 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱동하다라고한다. 그렇기 때문에 멱등성을 가지는 메서드인 PUT과 그렇지 않은 POST는 구분해서 사용해야한다.
PUT 과 PATCH도 구분해서 사용해야한다. PUT은 교체, PATCH는 수정의 용도로 사용해야한다.
자세한 내용은 MDN HTTP request methods 를 참고하자.

4) 3단계
마지막 단계는 HATEOAS(Hypertext As The Engine Of Application State)라고 표현되는 하이퍼미디어 컨트롤을 적용한다.
3단계 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 다르다.
이때 응답에 들어가게되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.
(응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트 !!!!)

만약 클라 개발자들이 응답에 담겨있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게하는 트리거가 될 수 있다.