REST API

Achivement Goals

• REST API에 대해 이해할 수 있다.
  • REST API 문서를 읽을 수 있다.
  • REST API에 맞춰 디자인할 수 있다.
  • Open API와 API Key에 대해 이해할 수 있다.
• Postman이 무엇인지 이해하고 사용할 수 있다.
  • HTTP API 테스팅이 무엇인지 알 수 있다.
  • Postman을 사용하여 서버에 GET, POST 요청을 보내고 응답을 받을 수 있다.
  • (Optional) Postman을 사용하여 Open Weather Map Open API에 요청을 보낼 수 있다.

REST API(“Representational State Transfer API”)

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

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

• REST 성숙도 모델 - 0단계
  조건: HTTP 프로토콜을 사용
  

• REST 성숙도 모델 - 1단계
  조건: HTTP 프로토콜을 사용, 개별 리소스와의 통신을 준수

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

-> [표1] 엔드포인트로 /appointment, /doctors/허준, /slots/123를 사용

엔드포인트 작성시 주의할 점

1) 어떤 리소스를 변화시키는지, 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 작성.

2) 동사, HTTP 메소드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성

-> [표2] 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부 반환.

• REST 성숙도 모델 - 2단계
  조건: HTTP 프로토콜을 사용, 개별 리소스와의 통신을 준수, CRUD에 맞게 적절한 HTTP 메소드를 사용

• [표]

조회(READ)하기 위해서는 GET 메소드를 사용하여 요청을 보내고,
이때 GET 메소드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달합니다.

예약을 생성(CREATE)하기 위해서는 POST 메소드를 사용하여 요청합니다.

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

메소드 규칙

• GET 메소드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 합니다.

• POST 는 요청마다 새로운 리소스를 생성하고 PUT 은 요청마다 같은 리소스를 반환합니다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 합니다. 그렇기 때문에 멱등성을 가지는 메소드 PUT과 그렇지 않은 POST는 구분하여 사용해야 합니다.

• PUT 과 PATCH 도 구분하여 사용해야 합니다. PUT은 교체, PATCH는 수정의 용도로 사용합니다.

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

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

출처: 코드스테이츠