REST API

2023-01-28 최대 1 분 소요

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

HTTP 프로토콜을 사용하기만 해도 된다. → REST API의 출발 (기본단계)

개별 리소스와의 통신을 준수한다.

개별 리소스에 맞는 엔드포인트를 사용해야 한다는 것과 요청하고

받은 자원에 대한 정보를 응답으로 전달해야 한다.

이때 응답으로 리소스를 전달할 때도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한

성공 / 실패 여부를 반환해야 한다.

CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점을 둔다.

HTTP 메소드를 사용할 때 규칙을 확인하고 사용해야한다.

관련 리소스를 클라이언트가 Location 헤더에 작성된 URL을 통해 확인할 수 있도록 해야,

완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 본다,.

HATEOAS, 하이퍼미디어 컨트롤(Hypertext As The Engine Of Application State)을 적용한다.

2단계와 거의 동일하지만, 응답에는 리소스의 URL을 포함한 링크를 넣어

새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트이다.

응답을 받은 다음에 할 수 있는 다양한 행동을 위해 많은 하이퍼미디어 컨트롤을 포함한다.

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

로그인된 이용자에게만 자원에 접근할 수 있는 권한을 API Key 형태로 제공하고, 데이터를 요청할 때

API Key를 같이 전달해야만 원하는 응답을 받을 수 있다.