API

API (Application Programming Interface) – это набор правил и процедур, которые позволяют разным приложениям и сервисам взаимодействовать друг с другом. Проще говоря, это способ, которым одна программа может общаться с другой. API представляет собой совокупность готовых классов, функций, методов и протоколов для разработки ПО. Используя такие интерфейсы, программисты могут экономить время на создании базовой инфраструктуры.

Основная цель API – предоставить разработчику удобный инструментарий для быстрой интеграции и реализации нужного функционала. Например, используя интерфейс какого-либо сервиса, можно легко добавить в своё приложение его возможности: авторизацию пользователей, карты, кнопки оплаты и другие.

Функции и преимущества API

Виды и примеры API

Как использовать API

Как тестировать API

Вопросы-ответы

Функции и преимущества API

API выполняет несколько важных функций и имеет ряд преимуществ.

• Упрощение взаимодействия между программами. Приложения могут обмениваться данными и использовать функционал друг друга.
• Масштабируемость. Хорошо спроектированный API может обслуживать множество клиентов. Например, популярные интерфейсы от крупных компаний используют миллионы разработчиков по всему миру.
• Безопасность. Данный инструмент позволяет контролировать доступ к функционалу и данным, устанавливая ограничения для клиентов. Это гарантирует надежность и безопасность.
• Совместимость. Единый API может быть использован с клиентскими приложениями на разных платформах: десктопах, мобильных устройствах и других.
• Ускорение разработки. Интеграция готового интерфейса значительно быстрее написания функционала с нуля. Она экономит время и ресурсы.
• Новые возможности. Открытые API позволяют создавать уникальные сервисы на основе данных и функций других платформ.
• Наличие сообществ. Вокруг популярных API формируются сообщества разработчиков, помогающие друг другу в реализации проектов.

Таким образом, программные интерфейсы значительно упрощают разработку, повышают скорость и качество создания IT-продуктов. API приносит пользу как поставщикам, так и потребителям.

Виды и примеры API

По уровню доступа API можно разделить на:

• внутренние (закрытые):

• предназначены для использования в рамках одной компании/организации,
• недоступны сторонним разработчикам,
• позволяют интегрировать разные внутренние сервисы;

• партнерские:

• доступны только определенному кругу партнеров и клиентов,
• расширяют функционал партнерских сервисов;

• публичные (открытые):

• открыты для использования всеми желающими,
• предоставляют функционал широкому кругу разработчиков,
• используются в маркетинге для привлечения внимания клиентов к компании и увеличения продаж.

Назовем также виды веб-API (интерфейсов для взаимодействия веб-приложений по сети), используемые при создании HTTP-служб.

• SOAP (Simple Object Access Protocol). Это протокол обмена сообщениями на основе XML между веб-сервисами. Использует спецификацию WSDL для описания сервисов. Отличается высокой стандартизацией и строгой типизацией данных.
• REST (Representational State Transfer). Архитектурный стиль API, использующий HTTP протокол для обмена данными. Отличается простотой и гибкостью. Данные передаются в простых форматах: JSON и XML.
• RPC (Remote Procedure Call). Удаленный вызов процедур. Позволяет вызывать код на удаленном сервере так же, как локальные функции. Популярен в распределенных системах. Используют протоколы AMQP, Thrift, Avro.

Основные их различия заключаются в том, что SOAP и RPC более формализованы и строго типизированы, а REST – это архитектурный стиль, который гибко использует возможности HTTP. Выбор зависит от поставленных задач.

По области применения можно выделить, например, API:

• библиотек. Набор готовых классов и функций для использования в коде. Они упрощают разработку. К примеру, библиотеки jQuery, React;
• операционных систем. Предоставляют интерфейс для доступа к функциям ОС из приложений, например API Windows, POSIX;
• баз данных. Интерфейс для executing-запросов и управления базой данных из кода программ: MySQL API;
• для разработки мобильных приложений. Back4App, Google Firebase;
• для электронной коммерции. Amazon AWS, Shopify;
• для аналитики и мониторинга. Яндекс Метрика, Google Analytics;
• для финансовых операций. Stripe, PayPal и другие.

Streaming API используются для передачи потоковых данных в режиме реального времени.

Приведем еще несколько примеров программных интерфейсов.

• Google Maps API<. Предоставляет доступ к картам, геокодированию адресов и другим геосервисам от Google.

Google Maps

• Погодные приложения. Они делают запрос о погоде в определенной геолокации. API обрабатывает его и связывает со спутником, а затем предоставляет информацию пользователю.

Пример погодного приложения

• Кнопки авторизации. При их использовании сайт запрашивает данные об аккаунте на другом ресурсе. Затем пользователю предоставляется доступ.

Пример кнопки авторизации

Как использовать API

Вот основные шаги по работе с API.

1. Выберите нужный программный интерфейс. Определите, какой функционал требуется приложению и какой API его предоставляет. 
2. Изучите документацию. Она содержит сведения об адресах, методах API, передаваемых параметрах и структуре ответов. Без этого невозможно корректно вызывать программный интерфейс. Нужно понять принцип его работы.
3. Получите доступ. Для этого необходимо зарегистрироваться на платформе API и получить уникальные ключи и токены.
4. Подключите API в приложении. Добавьте его библиотеку в проект и импортируйте нужные классы и методы. Она упрощает работу с программным интерфейсом. Библиотеку нужно подключить и импортировать в код.
5. Отправьте HTTP-запросы на адреса из документации. Вызовите методы API, передавая необходимые параметры в теле или URL запроса в соответствии с документацией.
6. Обработайте ответы в нужном формате. Проанализируйте ответы программного интерфейса, получая нужную информацию или статус работы методов. Чаще всего используется формат JSON, а также XML, CSV и другие.
7. Протестируйте интеграцию. Проверьте работу приложения с API в тестовом режиме, исправьте выявленные проблемы, если они есть.
8. Кэшируйте данные для оптимизации. Для ускорения работы с интерфейсом можно кэшировать часто запрашиваемые данные.

Как тестировать API

Для тестирования API можно использовать следующие подходы и инструменты:

• Unit тесты. Для тестирования отдельных методов API применяются юнит-тесты с проверкой разных сценариев, например JUnit, pytest, unittest.
• Моки (mocks). Специальные объекты-заглушки, поддерживающие работу API с заданными ответами без обращения к реальному сервису.
• Мониторинг логов. Анализ логов на предмет ошибок при интеграционном тестировании.
• Тестовый стенд. Отдельное тестовое окружение для проверки API в изоляции от основной системы.
• Postman. Приложение, которое позволяет делать запросы к API, задавая разные параметры, заголовки, тело. Оно удобно для ручного тестирования.
• Selenium. Дает возможность копировать пользовательские сценарии взаимодействия с API через GUI.
• SoapUI. Предназначен специально для тестирования API, генерирует тест-кейсы на основе спецификации.
• JMeter. Открытое ПО для нагрузочного тестирования. Позволяет адаптировать большое количество запросов к API.

Для полноценного тестирования программного интерфейса можно комбинировать разные подходы.