[Network] Rest API

REST API

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

원활한 통신을 위해 API를 모두가 잘 알아볼 수 있도록 작성하는 것이 중요합니다.

REST API 디자인

REST API를 작성 할 때는 지켜야할 규칙이 있습니다. 그 몇가지 규칙을 실용적으로 적용하기 위해 REST API 성숙도 모델이 만들어졌습니다.

-이미지 출처: 코드스테이츠

• REST 성숙도 모델 0단계

  단순히 HTTP 프로토콜을 사용하기만 해도 됩니다. 물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계입니다.

• REST 성숙도 모델 1단계

  개별 리소스와의 통신을 준수해야 합니다.
  REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현한합니다.
  따라서 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 하는 것이 1단계의 핵심입니다.

• REST 성숙도 모델 2단계

  CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둡니다.
  이에 관한 설명은 RestAPI Tutorial 에서 상세히 다루고있습니다.

• REST 성숙도 모델 3단계

  HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용합니다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 합니다.

Open API

글자 그대로 누구에게나 열려있는 API입니다. 그러나 "무제한으로 이용할 수 있다"라는 의미는 아닙니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있습니다.

API Key

API를 이용하기 위해서는 API Key가 필요합니다. API key는 서버의 문을 여는 열쇠입니다. 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없습니다. (가끔 API key가 필요하지 않은 경우도 있습니다.)

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