API 개념 정리 🙌

오늘 TIL은 드림 코딩 엘리님의 강의와 코드스테이츠에서 학습한 내용을 바탕으로 작성됐다. 또한, 그 어떠한 상업적인 용도도 없음을 밝힌다.

API란?

API의 정의는 다음과 같다.

그런데, 정의가 상당히 추상적이다. 방법이 뭔데??

이것을 쉽게 비유하자면, API라는 건 "식당 메뉴판"이라고 생각하면 된다.

고객들이 식당에서 주문을 어떻게 하나??

메뉴판 보고 거기에 적힌 메뉴들을 정확히 주문합니다. 즉, "식당의 메뉴판"이 곧 API이다.
=> 식당 주인과 음식을 주고 받기 위한 방법이라고 생각하면 된다.

---

웹서비스에서 API

실제 웹서비스를 예로 들어서, 거기서 API라는 용어를 설명해보도록 하자!!

필자가 코드를 막~~ 짜가지고, Web에다가 웹툰을 보내주는 프로그램을 만들었다고 치자!!
=> 이게 다른 말로 "웹툰 서비스"이다. 즉, 웹툰을 가져다주는 웹서버를 만들거다.

근데, 어떻게 사용자에게 웹툰을 보여줄 수있나??

사용자가 커스텀 주문 같은 거 할 수있나요?? "시리야, 나 드래곤볼 보고 싶어~~" 아니잖아요!!

내가 먼저 메뉴판 같은 걸 만들어줘야 한다.

나는 a웹툰, b웹툰을 보여줄 수 있다고 메뉴판을 만들어줘야 한다. 그래야, 서비스가 가능하다.

그래서, 실제 "웹 서비스"나 " 앱 서비스 "에서 쓰는 API라는 용어는 그냥 " 사용자가 서버랑 데이터를 주고 받는 정확한 방법 "이라고 보면 된다.
=> 서비스를 하기 위해서 미리 만들어 놓은 메뉴판이라고 보면 된다.

근데, 아직도 방법이라는 용어가 좀 추상적이다...

그래서 방법이 뭔데?? 메뉴판이라는 게 어떻게 생겼는데??

추상적으로 설명한 그 "방법"이라는 건, 바로 "코드"를 가리킨다.

API를 만들고 동작시키는 거, 전부다 코드로 이루어져 있다.

그럼, 이제 코드가 어떻게 생겼는지 봐야 이해가 될 것같아서 예시 코드를 보자!!

---

실제 코드를 통해 보는 웹서비스의 API

DB에서 웹툰 이미지를 뽑는 코드이다.

이 코드를 동작시키면, DB에서 웹툰을 뽑아서 갖다준다.

근데, 사용자가 이 코드를 어떻게 동작시킬 것인가?? 해킹을 해서, 개발자 컴퓨터에 침입을 하지 않는 이상, 이 코드를 동작시키지 못한다.

그래서, "식당 주인"인 필자가 API라는 코드를 짜둬야 한다.

Node.js에서는 다음과 같이 짠다.

간단하게, 뜻을 풀어보자면, " /detail/:id로 get요청을 하면, 안에 있는 코드를 실행해주세요~ " 라는 뜻이다.

바로 " 이 코드 "가 API라고 보면 된다.

어떤 유저가 이 URL로 get요청을 하면, 이 웹툰을 볼 수 있도록 개발자가 짜두는 거다.

그리고 유저한테 이거를 알려주면 되겠죠!!

메뉴판처럼 어딘가에 보여주면 된다.

실제 네이버 웹툰을 보려면??

실제로도 네이버 웹툰을 보려면, 이렇게 get 요청을 해야한다.

이거를 어떻게 하냐구요??

좀 이따 알아보자!!

---

API가 가져야할 내용

API를 작성하려면, 작성하는 법이 정해져있다.

• 정보를 보내줄 건지, 저장할 건지 등등
  

• 어떤 자료를 요청할 건지... 이거를 endpoint라고 한다. URL 형식으로 많이 저장한다.
  

• 파라미터가 들어갈 수 있다. 유저가 웹툰 볼 때, 부가적으로 실어보낼 정보 같은 거 있는지를 첨부할 수있다.
  

• 그리고 웹API라는 걸 개발 할 때는 REST API라는 원칙이 있는데, 이해가 쉽고 관리가 쉬운 API를 작성하는 방법론이다.
  

그래서, API를 이렇게 만든다고 알아봤는데, 유저 입장 한 번 생각해보자!!

---

유저 입장에서 보는 API

유저는 아래와 같은 경로로 get 요청을 하면, 웹툰을 보여준다면서요??

근데, 유저도 코드를 작성해야한다. 코드를 작성해야 데이터를 꺼내올 수가 있다. 모든 건 다 코드를 짜서 통신을 하게 되있다. 즉, 유저는 코드를 짜서 원하는 API로 주문을 해야한다.

코드를 못 짜겠다고요?? 사실, 여러분은 평소에 맨날 코드를 짜고 있습니다.

실은 API를 요청할 수있는 가장 쉬운 도구를 하나 가지고 있다.

바로 " 브라우저 "라는 거다.

브라우저를 열면,

이 공간이 API를 요청하는 공간이라고 보면 된다.

여기다가 endpoint를 작성하면, 사용자가 get 요청을 날릴 수가 있다.

즉, 주소창이 API 요청을 할 수있는 공간이다.

하지만, 실제로 사용자가 주소창에 코드를 적지는 않는다. 왜냐면, HTML 파일 안에다가 API 요청들을 쉽게할 수 있는 버튼들이 숨겨져있기 때문이다.

버튼을 누르면, " 이리로~ get 요청을 해주세요~~ " 하는 코드가 숨겨져있다.

그래서, 평소에는 별로 코드 짤 일이 없습니다.

---

Open API, Public API

회사 내부에서 사용하는 API를 외부의 다른 개발자가 이용할 수있도록, 공객적으로 오픈한 것을 Open API라고 한다.

이런 오픈된 API를 통해서, 많은 개발자들이 독창적이고 재밌는 어플리케이션을 만들 수 있고, 궁극적으로 회사 서비스 커뮤니티에 많은 기여를 하기 때문에 많은 회사에서 이런 오픈 API를 만들어 둡니다.

Open API list

• 엘리가 제일 추천 하는 리스트
• 두번째로 추천 하는 리스트
• 카카오 Open API

---

모든 API가 public은 아니다

API가 항상 public할 필요는 없다.

private API를 만들어서, 사내 프로그램들끼리 통신이 필요할 때, 쓸 수도 있다.

아니면, 내가 미리 정한 사람들끼리만 쓸 수있게 하는 partner API도 만들 수가 있다.

---

Web 말고 다른 곳에도 API는 존재한다

당연한 말이지만, Web 말고 다른 곳에서도 API는 존재한다.

예를 들어서, 운영체제인 Window도 프로그램이다. 그래서, Window API라는 걸 제공한다. 그거를 갖다쓰면, Window OS가 제공하는 여러가지 기능들을 갖다 쓸 수있다.

ex) 알림, 파일 설치/삭제 등등

혹은, 데이터베이스에서 내가 데이터를 뽑고 싶다면??

그러면, DB 관리 프로그램들이 있겠죠?? 거기가 제공하는 API를 갖다쓰면, DB랑 쉽게 데이터를 주고 받을 수있다.

프로그램이 존재하면, 반드시 그 API도 존재한다.
왜냐면, 그 프로그램을 동작시키기 위한 방법이 떄문이다. 메뉴판임!!

---

API로 만드는 비즈니스 모델

API는 항상 무료일 이유도 없다.

아주 유용한 API를 본인이 만들었다면, 판매할 수도 있다.

API를 판매하는 플렛폼

요즘 네이버가 밀고 있는 Cloud Platform 이라는 게 있다.

Papago 번역 서비스를 써본 적이 있을 거다. => 번역 잘 해준다.

근데, 실은 Papago 번역 서비스는 일정 글자 수까지만 무료이다. 그 수를 넘어가면, 과금이 된다.

그런 식으로 Papago API라는 걸 공개해서, 번역 서비스를 API 형식으로 팔기도 한다.

뭐 이런 것도 있다.

"Clova 요약 서비스"라고 긴 글을 보내면, 3줄로 깔끔하게 요약해서 return해준다.

이런 거 쓰려면, API 호출 1회당, 2원을 내야한다.

이런 식으로, API 호출마다 과금을 해줄 수도 있다.

---

아니면, 좋은 API를 만들었다면, API Marketplace에다가 올려서 팔아보자!!

그러면, 여러분들이 제공하는 API가 필요해지는 회사들이 돈 내고 쓸 수도 있는 거고요.

그런 식으로 여러가지 API를 활용한 비즈니스 모델이 많다. 여러분들도 API 만들어서 함 팔아보자!!

---

API를 좀 더 어렵고 정확하게 정의하면

API(Application Programming Interface)는 응용 프로그램 프로그래밍 인터페이스이다. 즉, 응용 프로그램에서 사용할 수 있도록, 운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 인터페이스를 뜻한다. 주로 파일 제어, 창 제어, 화상 처리, 문자 제어 등을 위한 인터페이스를 제공한다.

API의 역사

그런데, 1990년도 인터넷이 대중화되면서, 더이상 로컬환경뿐만 아니라, 다양한 기기들이 인터넷을 통해서 의사소통해나가는 시대가 왔다.

이 때 다양한 기기에서 서버에 있는 데이터를 읽고 쓰기 위해서는 서버에서 제공하는 Web API들을 이용해서 처리할 수 있다.

여기서, 네트워크에서 기기들간에 의사소통을 해나가는 규격 사항을 HTTP라고 부르구요.

또한, 이런 Web API를 어떻게 디자인해서 만들건지 정의하는 것이 존재한다. 예전에는 SOAP이라는 모든 네트워크 요청과 반응을 HTML처럼 생긴 XML이라는 데이터 포맷에 저장해서 주고 받았다. 그러나, 요즘에는 REST가 보편적으로 많이 사용되어진다.

---

확장된 API의 의미 - class나 함수

그리고 이제는 이런 Web API 뿐만 아니라,

라이브러리나 프레임워크에서 우리가 이용할 수 있는 class나 함수들을 API라고 부른다.

예를 들어 )

프로젝트 내부에서 쓰여지고 있는 클래스나 모듈이 있다면, Calculator에서 제공하는

2가지의 함수를 이용해서
( = 2가지의 인터페이스를 이용해서 )
( = 2가지의 API를 이용해서 )

사용하면 돼. 라도 할 수있습니다.
함수 === 인터페이스 === API

바로 이 점이 가끔 나를 헷갈리게 했다;;;

---

이처럼 API는 다양한 부분에서 사용되어 지는 단어이다.

내부의 구현 사항을 잘 숨겨두고, 외부에서 사용하는 사람이 필요한 것만 노출해 두고, 이것을 "인터페이스 or API" 라고 부르는 거죠.

---

인터페이스이란??

예를 들어, 자판기 기계가 내부적으로 어떻게 동작하는지 몰라도, 인터페이스를 통해서 기계를 쉽게 사용할 수 있다.

인터페이스(interface)란 사물과 사물 사이 또는 사물과 인간 사이의 경계에서, 상호 간의 소통을 위해 만들어진 물리적 매개체나 프로토콜을 말한다.

그리고 이 인터페이스가 간단하고, 더 직관적일수록 더 좋은 기계라고 할 수 있다.

바로 이런 것처럼 프로그래밍에서도 API라는 것이 존재한다.

---

추가 자료 출처

• 코딩초보들이 헷갈리는 용어 : API가 뭐냐면