코드스테이츠 부트캠프

REST API

als982001 2023. 1. 31. 11:49

1. REST API

  • REST API(Representational State Transfer): 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고 HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식. Roy Fielding의 박사 학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로 처음 소개됨.

 

Richardson 성숙도 모델

  • REST 성숙도 모델: REST API를 작성할 떄 지켜야 할 4단계의 규칙들. 
    • HTTP API: 성숙도 모델을 3단계까지 지키기 어려워 2단계까지 적용한 경우

2. REST 성숙도 모델 - 0단계

REST 성숙도 모델 0단계

  • REST API를 작성하기 위한 기본 단계로, 0단계는 단순히 HTTP 프로토콜을 사용하기만 해도 됨. 
  • 위의 예에서는 엔드포인트(Endpoint)를 모두 /appointment로 사용함.

 

3. REST 성숙도 모델 - 1단계

성공 시

 

실패 시

  • 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해 요청하고 받는 자원에 대한 응답으로 정보를 전달해야 함.
  • 0단계와는 다르게, 위의 예에서는 엔드포인트를 구분하여 사용함.
  • 리소스 사용에 대한 성공/실패 여부를 반환해야 함.

 

4. REST 성숙도 모델 - 2단계 (여기까지 하면 HTTP API라고도 함)

REST 성숙도 모델 2단계

  • CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 두는 단계.
  • 예약 가능한 시간을 확인하는 것은 조회(READ) → GET 메서드
    • body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달
  • 해당 특정 시간에 예약하는 것은 예약을 생성(CREATE) → POST 메서드
    • 새롭게 생성된 리소스를 보내주기 때문에 응답 코드는 201 Created로 명확하게 작성해야 함.
  • HTTP 메서드 사용할 떄의 규칙
    • GET 메서드는 서버의 데이터를 변환시키지 않는 요청에 사용
    • POST 메서드는 요청마다 새로운 리소스를 생성하고  PUT 메서드는 요청마다 같은 리소스를 반환함.
      • 멱등(Idempotent): 매 요청마다 같은 리소스를 반환하는 특징.
    • PUT은 교체, PATCH는 수정의 용도로 사용

 

5. REST 성숙도 모델 - 3단계 

REST 성숙도 모델 3단계

 

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

6. Open API & API Key

  • Open API: 누구에게나 열려있는 API. 하지만 무제한으로 이용할 수 있지는 않음. 
  • API Key: API를 이용하기 위해 필요한 key.