Для чего используют API?

Для чего используют API

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

Основное определение

API — это интерфейс, который определяет как одна программа может попросить услугу у другой. Это как меню в ресторане: ты заказываешь блюдо (запрос), повар готовит (обработка), ты получаешь результат (ответ).

Зачем нужны API

1. Интеграция систем

Rазные системы используют разные технологии, языки, БД. API позволяет им взаимодействовать:

Пример: E-commerce платформа

Мобильное приложение
         ↓
      API
         ↓
  Backend сервер
         ↓
  Платежная система (Stripe API)
         ↓
  Банк

Без API пришлось бы интегрировать все компоненты напрямую — невозможно.

2. Разделение ответственности

API позволяет разделить работу между командами:

• Frontend команда → использует API
• Backend команда → создаёт API
• Mobile команда → использует тот же API
• Third-party разработчики → создают приложения на базе API

Каждая команда работает независимо, главное — соблюдать контракт API.

3. Масштабируемость

API позволяет масштабировать архитектуру:

Монолит (плохо масштабируется):
Всё в одном приложении
  ↓
Микросервисы (хорошо масштабируется):
Множество сервисов, общаются через API
  ↓
Большие системы

Каждый микросервис может быть развёрнут отдельно, масштабирован независимо.

4. Переиспользование функционала

Однажды написанный API может использоваться многими приложениями:

Пример: Яндекс.Карты API

• Используется в Яндекс.Навигаторе
• Используется в приложениях третьих лиц
• Используется в веб-сайтах
• Используется в корпоративных системах

Одно API — множество потребителей.

5. Безопасность

API предоставляет контролируемый доступ к функциям и данным:

Прямой доступ (опасно):
Внешнее приложение
         ↓
Директно к БД
         ↓
Проблемы: SQL injection, утечки данных

Через API (безопасно):
Внешнее приложение
         ↓
      API (валидация, аутентификация)
         ↓
Контролируемый доступ к БД

API может:

• Требовать аутентификацию (Login)
• Проверять права доступа (Authorization)
• Валидировать данные
• Логировать операции
• Ограничивать скорость (rate limiting)

6. Гибкость и эволюция

API позволяет менять реализацию без изменения интерфейса:

Версия 1: API использует SQL базу
Версия 2: API теперь использует NoSQL (изменилась реализация)
Клиенты: ничего не заметили, интерфейс не изменился

Примечание: следует использовать версионирование API (/v1/, /v2/).

7. Улучшение производительности

API можно оптимизировать в одном месте, все клиенты получат выгоду:

Если API кэширует результаты:
  Первый запрос: 500ms (обработка в БД)
  Второй запрос: 10ms (из кэша)

Все клиенты пользуются кэшем автоматически

Типы API в зависимости от использования

REST API (самый популярный)

Для веб-приложений, мобильных приложений, интеграции с третьими сторонами.

Пример: GitHub API

GET /repos/{owner}/{repo}/issues
POST /repos/{owner}/{repo}/issues

Преимущества:

• Простой, легко понять
• Использует стандартные HTTP методы
• Легко кэшировать
• Хорошо документируется (OpenAPI/Swagger)

GraphQL API

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

Пример: GitHub GraphQL API

query {
  repository(owner: "facebook", name: "react") {
    issues(first: 10) {
      edges {
        node {
          title
          createdAt
        }
      }
    }
  }
}

Преимущества:

• Клиент выбирает ровно те данные, которые ему нужны
• Меньше овер-fetching и under-fetching
• Сильная типизация

gRPC API

Для микросервисов и высоконагруженных систем.

Пример: общение между микросервисами

service UserService {
  rpc GetUser(UserId) returns (User);
  rpc CreateUser(CreateUserRequest) returns (User);
}

Преимущества:

• Очень быстро (binary protobuf вместо JSON)
• Можно использовать streaming
• Строгая типизация

WebSocket API

Для real-time взаимодействия (чаты, уведомления, игры).

Пример: чат приложение

По WebSocket отправляются сообщения в real-time
Вместо REST polling (опрашивать каждые 5 секунд)

Применение API в различных сценариях

E-commerce платформа

Мобильное приложение
  ↓ (использует API)
Backend
  ↓ (использует API)
Платёжная система (Stripe API)
Система доставки (DPD API)
Детектор фрода (Siftscience API)

Social Network

Веб-приложение
  ↓ (REST API)
Be ekend
  ↓ (использует API)
Система хранения файлов (S3 API)
Поиск индекс (Elasticsearch API)
Пушнотификации (Firebase API)

IoT система (умный дом)

Датчик температуры
  ↓ (отправляет через API)
Backend сервер
  ↓ (обработка данных через API)
Мобильное приложение
  ↓ (отправляет команды через API)
Умная лампочка

Жизненный цикл разработки API

1. Определение требований → какие операции нужны
2. Проектирование → структура API, endpoints, формат данных
3. Документация → OpenAPI/Swagger для клиентов
4. Реализация → написание кода
5. Тестирование → unit, интеграционные, e2e тесты
6. Развёртывание → на production
7. Мониторинг → отслеживание errors, performance
8. Версионирование → как правило /v1/, /v2/ при больших изменениях

Ошибки при разработке API

• Плохая документация → разработчики не понимают как использовать
• Несоответствие версий → breaking changes без версионирования
• Отсутствие rate limiting → DDoS и abuse
• Плохая производительность → timeouts, slow requests
• Неправильные статус-коды → клиенты не понимают ошибки
• Отсутствие аутентификации → данные доступны всем
• Нет логирования → сложно отлаживать проблемы

Роль System Analyst с API

1. Проектирование → определить endpoints, параметры, ответы
2. Документация → написать OpenAPI spec
3. Требования → какие операции критичны, SLA
4. Интеграция → как API интегрируется с другими системами
5. Мониторинг → какие метрики отслеживать
6. Масштабирование → как API справится с нагрузкой

Заключение

API — это центральный элемент современной архитектуры. Хороший API:

• Простой для понимания и использования
• Документированный с примерами
• Надёжный обрабатывает ошибки корректно
• Производительный отвечает быстро
• Безопасный требует аутентификацию
• Масштабируемый справляется с нагрузкой

Для System Analyst навыки проектирования API — обязательны.