REST API

허정·2022년 6월 13일
0

REST API에서 REST는 “Representational State Transfer”의 약자입니다. 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었습니다. REST API는 웹에서 사용되는 데이터나 리소스를 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식입니다. 단계별로 알아봅시다 🙂

1. REST API 성숙도 모델 - 0단계

http 사용하기만 하면 0단계입니다.

2. REST API 성숙도 모델 - 1단계

1단계에서는 개별 리소스와의 통신을 준수해야 합니다.

  • 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 함
  • 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 함

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

3. REST API 성숙도 모델 - 2단계

(1) 적절한 HTTP method 사용

2단계에서는 CRUD에 맞게 적절한 HTTP 메소드를 사용해야 합니다.

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

이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created 로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인 할 수 있도록 해야, 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있습니다.

(2) 메소드 사용 규칙

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

4. REST API 성숙도 모델 - 3단계

마지막 단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용합니다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 다릅니다.

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

0개의 댓글