[S2U8] REST API

개발일지·2022년 8월 5일
0

REST API


Rest

REST는 “Representational State Transfer”의 약자로, 로이 필딩 (Roy Fielding)의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었습니다.

REST API

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

REST 성숙도 모델


레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었습니다.

REST 성숙도 모델은 총 4단계(0~3단계)로 나누어집니다.

0단계

0단계는 REST API를 작성하기 위한 기본 단계입니다.
단순히 HTTP 프로토콜을 사용하기만 해도 됩니다.

1단계

1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 합니다.
0단계에서는 요청에서의 엔드포인트로 모두 /appointment를 사용하였지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용합니다.
엔드포인트 작성 시에는 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법입니다.
요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 합니다.

2단계

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

3단계

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


Open API


Open API는 글자 그대로 누구에게나 열려있는 API이지만 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있습니다.

API Key


API를 이용하기 위해서는 API Key가 필요합니다.

profile
Frontend Engineer

0개의 댓글