REST API

Representational State Transfer

웹에서 사용되는 데이터나 리소스를 HTTP URL로 표현하고
HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식

REST API 디자인 (REST 성숙도 모델)

HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는
알아보기 쉽고 잘 작성된 메뉴판이 필요하다

➡️ REST API의 역할

0️⃣ 0단계 - HTTP 사용

REST API의 출발점 : HTTP 프로토콜 사용

1️⃣ 1단계 - 개별 리소스와의 통신 준수

개별 리소스와의 통신 준수

REST API는 웹에서 사용되는 모든 데이터나 리소스를 HTTP URI로 표현
따라서, 모든 리소스는 개별 리소스에 맞는 엔드포인트(EndPoint)를 사용해야함

요청하고 받는 리소스에 대한 정보를 응답으로 전달해야한다는 것이 1단계의 핵심
요청 후 리소스에 대한 정보와 함께 리소스 사용에 대한 성공 / 실패 여부 포함한 응답을 받아야한다

2️⃣ 2단계 - HTTP 메서드 원칙 준수

CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점

EX)
조회할 경우 (READ) - GET 메서드 사용
생성할 경우 (CREATE) - POST 메서드 사용
업데이트할 경우 (UPDATE) - PUT, PATCH

요청에 대한 응답이 어떻게 반환되는지 중요
➡️ 응답코드, 관련 리소스를 클라이언트가 Location헤더에 작성된 URI를 통해 확인할 수 있도록 해야한다.

⚠️ HTTP 메서드 유의 사항

• GET메서드는 서버의 데이터 변화시키지 않는 요청에 사용
• POST메서드는 요청마다 새로운 리소스를 생성
• PUT메서드는 요청마다 같은 리소스를 반환 (멱등성을 가진다)
  멱등(idemepotent) : 매 요청마다 같은 리소스를 반환하는 특징

2단계까지 적용하면 대체적으로 잘 작성된 API라고 할 수 있습니다

3️⃣ 3단계 - HATEOAS 원칙 준수

• Hypertext As The Engine Of Application State 약어로 표현되는
  하이퍼미디어 컨트롤을 적용

3단계의 요청은 2단계와 동일하지만
응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성

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

즉, 응답을 받은 클라이언트가 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심

Open API

누구에게나 열려있는 API

그러나 무제한으로 이용 불가능
API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있습니다.

API Key

서버의 문을 여는 열쇠

API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고,
데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있습니다.