9월 3일 (금) REST API

남이섬·2021년 9월 3일

CSR(Client Side Rendering)에서는 몇 가지의 메소드를 이용해 서버와 통신한다.
GET을 통해 웹 페이지나 데이터를 요청하고,
POST로 새로운 글이나 데이터를 전송하거나
DELETE로 저장된 글이나 데이터를 삭제할 수 있다

REST API

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

REST API는 웹에서 사용되는 모든 자원을 HTTP URI로 표현하고,
HTTP Method를 통해 요청과 응답을 정의하는 방식을 말한다(GET, POST 등)

REST API를 사용한다는 것은 REST 아키텍처의 제약 조건을 준수한다는 말이다

Endpoint

root-endpoint(혹은 root-URL)
API로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점을 뜻 한다

ex)
Github API의 root-endpoint는 https://api.github.com이고,
트위터 API의 root-endpoint는 https://api.twitter.com이다

일반적으로 root-endpoint는 도메인 주소의 루트(/)를 가리킨다
마찬가지로 Message States Server 의 URL을 기준으로 파악할 수 있는 root-endpoint는 Message States Server의 가장 마지막 Location인 호스트의 루트(/)이다

path: path(또는 url-path)는 API를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key 역할을 합니다. 서버에 정의된 문자열에 따라 path가 달라집니다. 예를 들어, https://api.github.com/user 에서는 'user'가 path입니다.

path
path(또는 url-path)는 API를 통해 서버와 통신할 때,
서버와 통신할 수 있는 key 역할을 한다
서버에 정의된 문자열에 따라 path가 달라진다
예를 들어, https://api.github.com/user 에서는 'user'가 path다

메세지 조회

Request

[요청] githubID가 작성한 모든 메시지를 조회

GET /{githubID}/messages

{githubID} 부분은, 요청하는 사람의 아이디를 넣는다
다음과 같이 작성할 수 있다

[요청] Southbig이 작성한 모든 메시지를 조회

GET /Southbig/messages

이 요청에는 추가적인 파라미터(query parameter)를 사용할 수 있다
파라미터는 다음과 같이 사용할 수 있다

/Southbig/messages?roomname=로비

Response

응답은 다음과 같은 JSON 형식

[데이터] Request에 따른 Response 예시

[
  {
    "id": 1,
    "username": "Southbig",
    "text": "안녕하세요",
    "roomname": "로비",
    "date": "2021-07-28T03:54:21.134"
  },
  // ...여러 개의 메시지
]

메시지에서 사용하는 속성

메시지 추가

Request

[요청] githubID가 작성한 메시지를 생성

POST /{githubID}/messages

{githubID} 부분은, 각 개인의 아이디를 넣는다
메시지는 24시간마다 자동으로 리셋된다

요청 본문엔 다음 내용을 반드시 포함해야 한다

요청 형식: JSON
MIME 타입: application/json

파라미터 정보

Response

응답은 다음과 같은 JSON 형식

[데이터] Request에 따른 Response 예시
{
  "id": 5
}

id는 숫자 형식이며, 새로 생성된 메시지의 고유한 ID값

메시지 초기화

Request

[요청] githubID가 작성한 메시지를 초기화

POST /{githubID}/clear

요청 본문은 필요하지 않다

Response

응답은 다음과 같은 JSON 형식

[데이터] Request에 따른 Response 예시
{
  "message": "message initialized!"
}

REST API 다지인

REST API는 공식적으로 정해진 뚜렷한 규격이 없다
개발자에 따라 REST API 특징(원칙)에 맞춰 조금씩 다른 모습을 하고 있다
그러나 REST API 모범 사례는 여전히 논의되고 통합되고 있기 때문에, 수많은 디자인 중에 분명히 보기 좋은 REST API 디자인은 있다

5가지의 기본적인 REST API 디자인 가이드
호주 정부 API 작성 가이드
미국 백악관 API 작성 가이드
구글 API 작성 가이드

REST API 설계시 가장 중요한 두 가지

URI는 정보의 자원을 표현합니다.
자원에 대한 상태 정의는 HTTP method(GET, POST, PUT, DELETE...)로 표현한다

ex)
GET /user/1122/post라는 URI는 REST API에 부합하지 않다
POST /user/1122처럼 표현하는 것이 REST API 규칙에 부합하다

Open API와 API Key

Open API

정부에서 제공하는 공공데이터가 있으며, 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있다
공공데이터포털에 접속해 원하는 키워드를 검색하면, 해당 키워드와 관련된 API를 확인할 수 있다

이 API에는 "Open"이라는 키워드가 붙어 있다
글자 그대로 누구에게나 열려있는 API이지만, "무제한으로 이용할 수 있다"는 의미는 아니다
기관이나 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다

ex)
Open API를 간단하게 경험해 볼 수 있는 대표적인 페이지는, Open Weather Map이라는 웹 사이트에서 제공하는 날씨 API이다
이 웹사이트에서는 다음의 설명처럼 데이터를 제공한다

제한적이나마 무료로 날씨 API를 사용할 수 있다
프리 플랜에서는 기본적으로 분당 60번, 달마다 1백 번 호출이 가능합니다.
데이터를 JSON 형태로 응답한다

API Key

API를 이용하기 위해서는 API Key가 필요하다
API key가 필요하지 않는 경우도 있지만 서버에서 데이터를 제공 받기 위해선 대부분 API key가 필요하다
서버를 사용하기 위해선 비용이 발생한다
로그인된 이용자에게만 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야만 원하는 응답을 받을 수 있다