Понимание API и прокси API

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

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

Видео. Посмотрите это короткое видео, чтобы познакомиться с прокси-серверами API.

Что такое API?

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

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

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

Edge также позволяет создавать API-интерфейсы путем реализации приложений, размещенных на платформе API-сервисов, без использования серверной службы. Вы можете создавать эти приложения на 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 для создания прокси-серверов API путем выполнения серии запросов REST к Edge.
  • Разверните приложение Node.js в качестве прокси. См. раздел «Развертывание автономного приложения Node.js» .

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

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

Создайте свой первый прокси API

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

Отличный способ узнать о прокси-серверах API — поработать с примерами, как описано в разделе Использование примеров прокси-серверов API .

Узнать больше