HTTP/네트워크 -2-

https://aws.amazon.com/ko/what-is/api/

REST API (Representational State Transfer)

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

 

REST는 클라이언트가 서버 데이터에 액세스하는 데 사용할 수 있는 GET, PUT, DELETE 등의 함수 집합을 정의,

클라이언트와 서버는 HTTP를 사용하여 데이터를 교환.

REST API의 주된 특징은 무상태.

무상태는 서버가 요청 간에 클라이언트 데이터를 저장하지 않음을 의미합니다.

서버에 대한 클라이언트 요청은 웹 사이트를 방문하기 위해 브라우저에 입력하는 URL과 유사합니다.

서버의 응답은 웹 페이지의 일반적인 그래픽 렌더링이 없는 일반 데이터입니다.

 

REST API 4가지 이점.

 

1. 통합 
API는 새로운 애플리케이션을 기존 소프트웨어 시스템과 통합하는 데 사용.
그러면 각 기능을 처음부터 작성할 필요가 없기 때문에 개발 속도가 빨라집니다.
API를 사용하여 기존 코드를 활용할 수 있습니다.

2. 혁신 
새로운 앱의 등장으로 전체 산업이 바뀔 수 있습니다.
기업은 신속하게 대응하고 혁신적인 서비스의 신속한 배포를 지원해야 합니다.
전체 코드를 다시 작성할 필요 없이 API 수준에서 변경하여 이를 수행할 수 있습니다.

3. 확장
API는 기업이 다양한 플랫폼에서 고객의 요구 사항을 충족할 수 있는 고유한 기회를 제공합니다.
예를 들어 지도 API를 사용하면 웹 사이트, Android, iOS 등을 통해 지도 정보를 통합할 수 있습니다.
어느 기업이나 무료 또는 유료 API를 사용하여 내부 데이터베이스에 유사한 액세스 권한을 부여할 수 있습니다.

4. 유지 관리의 용이성
API는 두 시스템 간의 게이트웨이 역할을 합니다.
API가 영향을 받지 않도록 각 시스템은 내부적으로 변경해야 합니다.
이렇게 하면 한 시스템의 향후 코드 변경이 다른 시스템에 영향을 미치지 않습니다.

REST 성숙도 모델 (RMM)

REST API를 잘 적용하기 위한 4단계 모델

 

단계	요약	설명
0단계	HTTP 사용	단순히 HTTP 프로토콜을 사용하기만 해도 됨. 물론 이 경우, 해당 API를 REST API라고 할 수는 없음. 단지 REST API를 작성하기 위한 기본 단계.
1단계	개별 리소스와의 통신 준수	개별 리소스(Resource)와의 통신을 준수. 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 핵심. 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용. 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요. 엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양. 리소스에 집중해 명사 형태의 단어로 작성하는 것을 권장. 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 함.
2단계	HTTP 메소드 준수	CRUD에 맞게 적절한 HTTP 메서드를 사용. GET : 서버의 데이터를 변화시키지 않는 요청에 사용. POST: 요청마다 새로운 리소스를 생성. (멱등하지 않음) PUT : 요청마다 같은 리소스를 반환. 교체의 용도로 사용 (멱등) PATCH : 수정의 용도로 사용. (PUT과 확실하게 구분해서 사용할 것) *매 요청마다 같은 리소스를 반환하는 특징 = 멱등(idempotent) 각자 구분을 잘 해서 사용해야 함. API를 작성시 2단계까지 적용하면 대체적으로 잘 작성된 API라고 함.
3단계	HSTEOAS 원칙 준수 (Hypertext As The Engine Of Application State)	HATEOAS라는 하이퍼미디어 컨트롤을 적용. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성. 이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함. 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 핵심.

 

Open API

정부에서 제공하는 공공데이터에 쉽게 접근할 수 있도록

정부는 Open API의 형태로 공공데이터를 제공.

공공데이터 포털에 접속해 원하는 키워드를 검색하면, 해당 키워드와 관련된 API 확인 가능

글자 그대로 누구에게나 열려있는 API는 맞음. 대신 API마다 정해진 이용 수칙이 있고

그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있음.

Open API를 간단하게 경험해 볼 수 있는 대표적인 페이지 : Open Weather Map
이 웹사이트에서는 다음의 설명처럼 데이터를 제공함.
제한적이나마 무료로 날씨 API를 사용 가능.
프리 플랜에서는 기본적으로 분당 60번, 달마다 1백 번 호출이 가능.
데이터를 JSON 형태로 응답.

 

API Key

API를 이용하기 위해 필요. 서버의 문을 여는 열쇠.

서버를 운용하는 데에 비용이 발생하기 때문에

서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없음.

(가끔 API key가 필요하지 않은 경우도 있긴 하지만) API Key가 필요한 경우에는

로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고

데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있음.