REST API 문서

정의

Representational State Transfer.

URI를 통해 자원을 표현하고, HTTP 프로토콜을 통한 요청과 응답의 방식을 정의한 것

(식당의 메뉴판과 같다. “00방식으로 주문하면, 00가 나옵니다”)

디자인 방법 3단계(REST 성숙도 모델)

0단계

단순히 HTTP 프로토콜을 사용하기만 해도 0단계를 충족한다.

즉 0단계는 REST API문서를 작성하기 위한 최소한의 조건이다.

문제점: 자원의 종류별로 다른 메서드를 사용하여야 한다.

1단계

요청할 (또는 보낼) 자원의 종류에 따라 적절한 엔드포인트를 사용하여야 한다

특히나 GET 요청은 body 부분을 사용할 수 없기 때문에 엔드포인트에 쿼리 파라미터를 사용해야 할 수도 있다.

여기서 엔드포인트란, HTTP request message의 start line을 말한다.

예를 들어, 블로그 글들 중 영화 리뷰 포스팅만 보고 싶은데 엔드포인트를 다음과 같이 작성했다면 부적절하다.