API и прокси API

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Apigee Edge позволяет легко и быстро создавать RESTful API, которые могут использовать разработчики приложений. Вы предоставляете доступ к API в Edge, создавая прокси API, которые действуют как управляемые "фасады" для внутренних сервисов. В этой статье рассказывается о взаимосвязи между API и прокси API в Apigee Edge.

Видео. Посмотрите короткое видео о прокси API.

Что такое API?

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

Поскольку приложения, использующие API, чувствительны к изменениям, API также подразумевают "контракт". Договор гарантирует, что API будет меняться предсказуемым образом.

Apigee Edge позволяет создавать API и, если они у вас уже есть, предоставлять к ним прямой доступ, добавляя уровень управления и видимости. Если у вас включены сервисы HTTP, например веб-сервисы на основе SOA, их также можно представить в виде API через Apigee Edge.

Кроме того, Edge позволяет создавать API, реализуя приложения, размещенные на платформе API Services, без использования бэкенд-службы. Вы можете создавать такие приложения на JavaScript, Java и Node.js.

Что такое прокси-сервер API?

Вы можете предоставлять доступ к API в Apigee Edge, реализовав прокси API. Прокси API отделяют API, используемый приложением, от внутренних сервисов, защищая приложение от изменений в коде внутренних сервисов. Пока вы вносите изменения в серверную часть сервисов, приложения продолжают вызывать тот же API без перебоев.

В конфигурации прокси-сервера API есть два типа конечных точек:

  • ProxyEndpoint. Определяет, как клиентские приложения используют ваши API. Вы можете настроить ProxyEndpoint, чтобы определить URL прокси-сервера API. Конечная точка прокси-сервера также определяет, будут ли приложения получать доступ к прокси-серверу API по протоколу HTTP или HTTPS. Обычно вы прикрепляете правила к ProxyEndpoint, чтобы обеспечить безопасность, проверку квот и другие типы контроля доступа и ограничения скорости.
  • TargetEndpoint. Определяет, как прокси-сервер API взаимодействует с вашими внутренними сервисами. Вы настраиваете TargetEndpoint так, чтобы он пересылал запросы в нужный внутренний сервис, а также определяете настройки безопасности, протокол HTTP или HTTPS и другую информацию о подключении. Вы можете прикрепить правила к TargetEndpoint, чтобы убедиться, что сообщения с ответами правильно отформатированы для приложения, которое отправило исходный запрос.

На рисунке ниже показано, как можно визуализировать прокси API.

HTTP-запросы поступают через конечную точку запроса прокси-сервера, передаются в конечную точку целевого запроса, а затем отправляются в серверные службы. Ответы HTTP поступают через конечную точку целевого ответа, передаются в конечную точку ответа прокси-сервера, а затем возвращаются клиенту.

Как создать прокси-сервер API?

Прокси-сервер API состоит из набора XML-файлов конфигурации и кода (например, JavaScript и Java). В Apigee есть несколько способов создания прокси API, в том числе:

  • Использование пользовательского интерфейса управления Edge для определения прокси-сервера API в графическом интерфейсе пользователя (GUI). Подробнее о том, как создать простой прокси-сервер API…
  • Создание XML-файлов и других вспомогательных файлов, определяющих прокси-сервер API, и их импорт в Edge.
  • Создавать прокси API с помощью Edge Management API, отправляя в Edge серию запросов REST.
  • Разверните приложение Node.js в качестве прокси-сервера. Подробнее о развертывании отдельного приложения Node.js…

Что такое политика?

Edge позволяет управлять поведением API без написания кода с помощью правил. Правило – это модуль, который реализует определенную ограниченную функцию управления в рамках потока запросов и ответов прокси-сервера. Правила позволяют легко и надежно добавлять в API распространенные функции управления. Правила предоставляют такие функции, как безопасность, ограничение скорости, преобразование и медиация, избавляя вас от необходимости самостоятельно писать код и поддерживать эти функции.

Как создать первый прокси-сервер API

В Apigee есть ряд руководств, которые помогут вам создать первый API. Начните с создания первого прокси-сервера API.

Чтобы узнать больше о прокси API, попробуйте использовать примеры, как описано в разделе Использование примеров прокси API.

Подробнее…