REST API

REST API에서 REST는 "Representational State Transfer"의 약자로, REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.

REST API 디자인하는 방법

레오나르드 리차드슨(Leonard Richardson)은 REST API를 실용적으로 적용하기 위한 4단계 모델을 만들었다.

엄밀하게 3단계까지 지키기 어려워 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API라고 부른다.

0단계 - HTTP 사용

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다.
이 경우, 해당 API를 REST API라고 부르긴 어려우며, 이 단계는 REST API를 작성하기 위한 기본 단계이다.

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

1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.

2단계 - HTTP 메소드 원칙 준수

HTTP 메소드의 종류는 총 9가지가 있다.

주요 메소드 5가지

• GET
  리소스 조회
  서버의 데이터를 변화시키지 않는 요청에 사용한다.
• POST
  요청 데이터 처리, 주로 데이터 등록에 사용
  요청마다 새로운 리소스를 생성한다.
• PUT : 리소스를 대체, 해당 리소스가 없으면 생성
  요청마다 같은 리소스를 반환한다. 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 POST는 구분하여 사용해야 한다.
• PATCH : 리소스를 일부만 변경
  PUT은 교체, PATCH는 수정의 용도로 사용된다. 이 둘은 구분하여 사용해야 한다.
• DELETE : 리소스 삭제

기타 메소드 4가지

• HEAD
  GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS
  대상 리소스에 대한 통신 가능 옵션을 설명(주로 CORS에서 사용)
• CONNECT
  대상 자원으로 식별되는 서버에 대한 터널을 설정
• TRACE
  대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

3단계 - HATEOAS 원칙 준수

HATEOAS(Hypermedia As The Engine Of Application State)란 "하이퍼미디어를 애플리케이션의 상태를 관리하기 위한 메커니즘으로 사용한다"이다.
간단히 얘기해서 클라이언트가 서버로부터 어떠한 요청을 할 때, 요청에 필요한 URI를 응답에 포함시켜 반환하는 것을 말한다.

Open API

Open API란 누구에게나 열려있는 API를 말한다.

대표적으로 정부에서 제공하는 공공데이터가 있다. 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있다.

Open API라고 해서 제한 없이 사용할 수 있다는 의미는 아니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.

API Key

API를 이용하기 위해서는 API Key가 필요하다.(API 마다 다르다. 없을 수도 있음)

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