REST API란?

REST는 “Representational State Transfer”의 약자로,
웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식이다.
쉽게 설명하면 1. 클라이언트가 식당에서 주문하는 것처럼 서버에 요청 -> 2. 서버에서 메뉴판에 있는 사진처럼 클라이언트에게 제공(전송)을 하는 과정을 거친다.
따라서 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서 알아보기 쉽고 잘 작성된 메뉴판이 필요한데 이게 바로 API가 하는 일이다.

REST 성숙도 모델 0단계

단순히 HTTP 프로토콜을 사용한다.
완전히 REST API라고 할 수 없고 이를 작성하기 위한 기본 단계다.

REST 성숙도 모델 1단계

개별 리소스와의 통신 준수
REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현하기 때문에, 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하고 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.

0단계의 요청에서는 엔드포인트로 모두 /appointment 를 사용했지만 1단계에서는 요청하는 리소스에 따라서 다른 엔드포인트를 사용한다.

엔드포인트를 작성할 땐 동사, HTTP 메서드, 어떤 행위에 대한 단어 등의 사용을 지양하고, 리소스에 집중해서 명사 형태의 단어로 작성하는 게 바람직하다.

요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보, 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

REST 성숙도 모델 2단계

REST 성숙도 모델 2단계의 핵심은 CRUD(Create, Read, Update, Delete)에 맞게 적절한 HTTP 메서드를 사용하는 것이다. 병원 예약을 예로 들면,
예약 가능한 시간을 확인하는 게 조회(READ)하는 것이니까 GET 메서드를 사용한다. GET 메서드를 사용해 요청을 보내고, GET 메서드는 body를 가지지 않아서 query parameter를 사용하여 필요한 리소스를 전달한다.
특정 시간에 예약하는 건 해당 특정 시간에 예약을 생성(CREATE)한다는 것과 마찬가지니까 POST 메서드를 사용한다. 이때, POST 요청에 대한 응답이 어떻게 반환되는지가 중요한데 새롭게 생성된 리소스를 응답으로 보내주기 때문에 응답 코드는 201 Created로 명확하게 작성해야 한다. 또한 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있게 하면 완벽하게 REST 성숙도 모델 2단계를 충족한 것이다.

HTTP 메서드를 사용할 때의 규칙

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

2단계까지 적용한 API는 잘 작성된 API다. 3단계까지 적용한 경우는 드물기 때문에 무조건적으로 3단계까지 적용해야 하는 건 아니다.

REST 성숙도 모델 3단계

REST 성숙도 모델 3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 하이퍼미디어 컨트롤을 적용하는 게 핵심이다. 3단계 요청은 2단계와 동일하지만, 응답엔 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다. 이 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.
예를 들어 의사의 예약 가능 시간을 확인하고 나서 그 시간대에 예약을 하는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수 있다. 이처럼 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 핵심이다.

open API

누구나 사용할 수 있도록 오픈된 API.
각각 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항이 있을 수 있다. 정부에서 제공하는 공공데이터 open API도 있고
네이버 오픈 API 등 기업에서 제공하는 것도 있다. Riot API를 이용해 만든 롤 전적 검색 사이트 등의 재밌는 예시도 있다.

API Key

https://developer.riotgames.com/ RIOT API

API를 이용하기 위해서 필요한 것으로, 서버의 문을 여는 열쇠다.
서버를 운용하는 데 비용이 발생하니까 서버 입장에서 아무 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무가 없어서 Key가 필요한 경우가 있는 것이다.
로그인한 이용자에게 자원에 접근할 권한을 API Key로 제공하고, 데이터 요청할 때 API Key를 같이 전달해야 원하는 응답을 받음.