-
초보자를 위한 API가이드, API란 무엇일까?카테고리 없음 2022. 2. 21. 20:53
IT업계로 도전하고 싶어 공부 중에 있습니다. (기존에 Notion으로 작성된 내용을 조금씩 수정해서 티스토리에 업데이트 중입니다.)
IT업계에서는 테크니컬 라이터가 API가이드를 작성한다고 하는데 API가이드가 뭐지?라는 궁금증이 생겼습니다. API가이드에 대해서 제일 친절하게 설명한 아티클 있어 제 의견을 덧붙여 번역해보고자 합니다. 원문은 페이지 하단에서 확인할 수 있습니다.
🎈오역과 의역이 있을 수 있습니다.
애플리케이션이 서로 어떻게 소통하는지 궁금한 적이 있으신가요? 애플리케이션은 Application Programming Interface(API)를 사용해 서로 대화합니다. 스포티파이를 통해 음악을 듣거나 넷플릭스에서 시청할 때마다 우리는 API를 간접적으로 사용하고 있습니다. 이 기사에서는 API가 우리 삶에서 얼마나 큰 영향을 미치고 있는지 간단하게 소개합니다.
API란?
API는 애플리케이션이 데이터에 접근하고 외부 소프트웨어 구성 요소, 운영 체제 또는 마이크로 서비스와 상호 작용을 할 수 있도록 하는 일련의 기능입니다. 간단하게 말하자면 API는 사용자 요청을 시스템에 전달하고 시스템의 응답을 다시 사용자에게 전송합니다.
API는 다른 시스템과 애플리케이션의 개발 과정을 빠르게 할 수 있기 때문에 많이 사용됩니다. 예를 들어 만약 사용자가 소프트웨어를 만들 때 얼굴 인식이나 처리를 통합하고 싶다면 API를 사용하는 것이 가장 좋은 방법입니다. 사용자의 소프트웨어를 다른 소프트웨어와 연결하기만 하면 되기 때문이죠. 소프트웨어를 연결할 때 개발자들이 원하는 기능들을 구현하는 것을 돕기 위한 API가이드가 제공됩니다.
API를 사용하면 소스코드를 처리할 필요도 없고 어떻게 동작하는지 이해할 필요도 없습니다. API가 어떻게 처리하는지 살펴보겠습니다.
API 작동 방식
API 사용 중인 애플리케이션과 서버 사이의 "중개자"라고 생각해보겠습니다. 사용자가 애플리케이션에게 무언가를 하라고 하면 애플리케이션은 API를 사용해서 웹 서버와 통신하고 애플리케이션에게 무엇을 해야 하는지 알려 줄 것입니다. 이런 행동을 요청(request)라고 합니다. 그 후에 서버는 사용자의 애플리케이션에 "중개자"가 전달할 응답을 보냅니다.
덜 추상적인 예를 하나 보겠습니다. 식당에 들어가서 전망 좋은 테이블을 고르고 웨이터가 주문을 받기를 기다리고 있다고 가정해보겠습니다. 이때 요리사는 주방에서 준비해야 할 다른 주문이 있기 때문에 직접 주문을 받을 수 없습니다. 여기서 웨이터가 주문을 받는 "중간인"이 됩니다. 웨이터에게 요청하면 웨이터가 부엌에 주문서를 보낸 다음, 주문받은 음식이 나오면 우리에게 가져다줍니다.
음식을 기다릴 때 주방에서 무슨 일이 일어나고 있는지 알지 못하는 것처럼 애플리케이션도 최종 결과만 알 뿐입니다. API의 기능이나 릴리즈 정책에 따라 다양한 API가 있습니다. 이러한 차별화 요소는 무엇인지 살펴보겠습니다.
사용 사례별 API
앞에서 언급한 것처럼 API를 사용하면 편리합니다. 특정 목표를 달성하기 위해서는 다양한 소프트웨어와 애플리케이션 간의 통신이 필수적이기 때문에 API는 사용자가 이루고자 하는 것을 기반으로 설계됩니다.
데이터 베이스 API: 응용프로그램과 데이터 베이스 관리 시스템 간의 통신을 더 쉽게 합니다. 예를 들어 파이어 베이스는 구글이 보유한 모바일 웹 애플리케이션 플랫폼으로 개발자가 서버를 관리하거나 서버 측 코드를 쓸 필요 없이 데이터를 단순하게 실시간 동기화하고 저장할 수 있도록 합니다.
운영 체제 API: 운영 체제도 Windows API나 Linux Kernel User-Space API와 같이 API를 가지고 있습니다. Apple에서 제공하는 macOS 및 iOS용 API도 developer 문서에서 찾을 수 있습니다.
Web API: 웹 애플리케이션에서 요청을 보내고 HTTP를 사용하여 서버에 응답을 보내기 때문에 가장 일반적으로 사용되는 APIs입니다. 개발자들은 Web API를 개발자의 App이나 사이트에서 사용함으로써 페이스북이나 구글을 통한 통합 로그인 방법을 구현할 수 있습니다. 또는 구글 맵 API를 이용한 지도 추가와 같은 기능을 사용하여 사용자에게 실용적인 기능을 제공할 수 있습니다.
릴리즈 정책별 API
일부 API는 내부용으로만 구축됩니다. 또 다른 API는 고객이 사용하는 소프트웨어와 통합하기 위한 제품으로 설계됩니다. 주요 범주는 다음과 같습니다.
개인 API: 주로 조직 내에서 사용되며, 직원들이 사용하는 시스템과 앱에 통합하고 내부 운영을 개선합니다. API가 대중들에게 공개된 것처럼 보여도, 인터페이스는 API에 대한 완전한 통제권을 가지고 있는 조직 내의 사람들에게만 이용 가능한 상태로 유지됩니다.
파트너 API: 한 개 이상의 비즈니스 파트너와 공유되기 때문에 추가적인 수익 흐름을 제공할 수 있습니다. 해당 파트너와 제공자 간의 합의가 이루어집니다. 파트너 API도 서비스에 가치를 더하고 업셀링 채널을 엽니다.
공개 API: 제3자 개발자라면 누구나 이용할 수 있는 API입니다. 제공 API는 사용자와 공급자 간에 긴밀한 관계를 맺지 않고도 수익 흐름을 증가시킬 수 있습니다. 공개 API를 사용함으로써 더 많은 사용자에게 접근하고 트래픽을 구축할 수 있으며 다양한 서비스를 지원할 수 있습니다. 공개 API는 두 가지로 나눌 수 있습니다.
오픈 API: 이 API는 개발자라면 누구나 사용할 수 있습니다. 즉, 제한적인 조건이 없고 API를 사용하기 위해 제공자의 동의가 필요 없습니다. API 사용 시 대가를 지불할 필요가 없다는 것을 의미합니다. 오픈 API는 개발자들이 접근할 수 있도록 공개 문서를 제공하며 응용프로그램을 테스트하고 만드는데 이용할 수 있습니다. 예를 들어 카카오나 네이버에서 '로그인 기능'을 구현할 수 있도록 소스를 제공해주는 것이 바로 오픈 API입니다.
상업 API: 이 API를 사용하려면 금액을 지불해야 합니다. 사용자가 시험 검토하기 위해 무료체험판을 제공하는 경우가 많습니다.
REST API
카카오 API는 대부분의 기능을 REST API로 제공한다고 합니다. REST API란 Roy Fielding이 2000년에 HTTP를 통해 결합된 애플리케이션을 설계하기 위해 만든 아키텍처 스타일로 API 개발에 자주 사용됩니다.
구체적으로는 웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고, 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식을 의미한다고 합니다. 즉, 정보를 고유한 URI로 표시되는 리소스로 취급하기 때문에 특정 리소스를 요청하려면 GET, POST, PUT, HEAD, DELETE, PATCH, OPTION과 같은 HTTP Method를 사용해서 해당 URI를 제공해야 합니다.
(REST API 규칙과 특징과 같은 자세한 사항은 다음 포스팅에서 다룰 예정입니다.)REST API는 HTTP 요청을 보낼 수 있는 환경이라면 어디서든 이용 가능합니다. 클라이언트에서 서버로, 또는 서버에서 서버로 요청을 보낼 수 있습니다. 예를 들면 다음과 같은 환경에서 REST API를 사용할 수 있습니다.
- 모바일/PC 웹 환경
- iOS, Android 등 모바일 환경
- Java, Ruby, Python 등 다양한 환경의 웹 서버
개발자는 간단한 작업을 수행하기 위해 많은 코드를 작성할 필요가 없기 때문에 REST API를 사용하는 것을 선호합니다.API가이드는 왜 작성할까?
오픈 API를 제공하는 카카오나 네이버는 API가이드도 같이 제공합니다. API 가이드 문서에는 해당 API를 효과적으로 사용하고 통합하는 방법에 대한 지침이 포함되어 있습니다. 잘 작성된 API는 개발 시간과 비용을 절감하는데 도움을 줄 수 있습니다. API 가이드 문서가 잘 작성되어있다면 기술적 지원을 제공하는 빈도가 낮아질 수 있습니다.
API가이드의 구성은 크게 3가지로 나눌 수 있습니다.
- 참조와 기능
- 가이드와 튜토리얼
- 예제와 사용 사례
카카오 디벨로퍼를 살펴보면 사용하는 언어별로 가이드를 제공하고 있으며 예제와 샘플 코드를 제공하고 있습니다. 기능을 설명하는 문서와 사용 사례를 정의하는 문서로 구분되어 있습니다.
카카오 디벨로퍼 API가이드 예시 소프트웨어와 마찬가지로 API가이드에도 유지관리가 필요합니다. API가 업데이트되었는데 API가이드 문서는 업데이트되지 않았다면 문서를 참고하는 사용자는 원하는 결과를 얻을 수 없습니다.
API 가이드 문서에 대해서는 다음 포스팅에서 예제를 통해 더 자세하게 다루어볼 예정입니다. 카카오 디벨로퍼 말고도 다른 사이트를 참고하고 싶으시다면 TwiiloDocs 사이트도 자세하게 정리되어있으니 해당 사이트를 참고하여 작성해보는 것도 좋을 것 같습니다.🤭
참고 사이트