[ 네트워크/HTTP ] REST API_기초 알아보기 3편

기초 알아보기 3편 

• 1편에서 나온 REST API 핵심 내용 정리
• Open API / API Key 내용 다루기

 

---

REST API 

• 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식

REST API 성숙도 모델

• REST API  작성시, 지켜야 할 규칙들을 잘 적용하기 위한 4단계 모델
• 2단계까지 적용해도 좋은 API 디자인이라고 할 수 있음

---

[ 단계별로 보기 ]

 

REST 성숙도 모델 - 0단계

• REST API 작성하기 위한 기본 단계
• 단순히 HTTP 프로토콜을 사용하기만 해도 된다.

 

REST 성숙도 모델 - 1단계

• 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.
• 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.
• 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

 

REST 성숙도 모델 - 2단계

• 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
• 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 완벽하게 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있다.

HTTP 메서드 사용 규칙

• GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
• POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다.
  이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등하다고 한다.
  그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 한다.
• PUT은 교체, PATCH는 수정의 용도로 사용한다.

 

REST 성숙도 모델 - 3단계

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

---

[ Open API / API Key 내용 정리 ]

 

Open API

• 정부에서 제공하는 공공데이터에 쉽게 접근할 수 있도록 Open API 형태로 공공 데이터를 제공하고 있다.
• API마다 정해진 이용 수칙이 있음, 이용 수칙에 따라 제한사항(가격,정보의 제한 등) 이 있을 수 있음
• Open API를 간단하게 경험해 볼 수 있는 대표적인 페이지 : Open Weather Map이라는 날씨 API

 

API Key

• API를 이용하기 위해서 필요함, 서버의 문을 여는 열쇠라고 할 수 있다.
• 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key 형태로 제공, 데이터를 요청할 때
  API Key를 같이 전달해야 원하는 응답을 받을 수 있음