Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
В этом разделе перечислены некоторые основные характеристики API-прокси, а также ссылки на дополнительную информацию.
API — это точки входа, позволяющие одному приложению использовать возможности другого. Для создания API используются API-прокси.
В Apigee Edge вы реализуете API-прокси, настраивая логику API-прокси как последовательность шагов, которые выполняются в ответ на запрос от клиентского кода. Вы предоставляете API-прокси клиентам, определяя конечные точки, которые включают URL-адрес с путями к ресурсам, HTTP-метод, требования к телу запроса и так далее.
Хотя его называют API-прокси, с точки зрения клиентского кода это и есть API .
Для получения общего обзора API-прокси см. раздел «Понимание API и API-прокси» .
Вы упорядочиваете последовательность логики API-прокси с помощью потоков.
В любом приложении потоки данных управляются логикой условий. В Apigee Edge путь обработки состоит из потоков. Поток — это последовательность этапов (или «шагов»), составляющих путь обработки API-прокси. Потоки позволяют Apigee Edge предоставлять места для применения логики и поведения в определенных точках — от клиента к бэкэнд-ресурсу, а затем обратно к клиенту.
Более подробную информацию о потоках см. в разделе «Управление выполнением прокси-сервера с помощью потоков».
Доступ к данным о состоянии осуществляется через переменные потока, создаваемые API-прокси.
API-прокси имеет доступ к переменным, представляющим состояние выполнения. Вы можете получить доступ к этим переменным из XML-файла, который настраивает ваши API-прокси и политики. Вы также можете получить к ним доступ при расширении API-прокси с помощью процедурного языка, такого как Java, JavaScript или Python.
Эти переменные хранятся в Apigee Edge. Некоторые существуют по умолчанию, обычно потому, что они являются общими для работы API-прокси (например, потому что они являются частью HTTP-запроса). Вы также можете создавать собственные переменные для удовлетворения логических требований.
Более подробную информацию о переменных см. в разделе «Управление состоянием прокси-сервера с помощью переменных потока» .
Вы можете настроить выполнение API-прокси в зависимости от условий.
Как и в большинстве языков программирования, в API-прокси код может выполняться условно. Условия часто основаны на состоянии API-прокси, к которому можно получить доступ через переменные потока. Например, можно задать условие, которое проверяет пользовательский агент, а затем обрабатывает запрос соответствующим образом.
Более подробную информацию об условном выполнении см. в разделе «Переменные и условия потока» .
Большую часть логики вы реализуете в API-прокси с помощью политик.
Большая часть логики, добавляемой в API-прокси, упаковывается в виде политик. Политика — это компонент Apigee Edge, который инкапсулирует логику для функциональной области, такой как безопасность или управление трафиком. Вы настраиваете политику с помощью XML-файла, который задает свойства для базовой логики. Вы располагаете политики в последовательности «шагов» в рамках потока, чтобы ваш API-прокси выполнял логику в оптимальном порядке для достижения целей вашего прокси.
Более подробную информацию о политиках см. в разделе «Что такое политика?» .
Вы можете включать многократно используемые наборы функций.
Когда ваш API-прокси включает логику, которая будет использоваться в нескольких местах вашего кода — например, другими API-прокси — вы можете объединить эту логику для вызовов из разных мест. Например, вы можете сгруппировать логику безопасности в общий поток, который вызывают другие API-прокси, уменьшая дублирование между API-прокси.
Более подробную информацию об общих потоках см. в разделе «Повторно используемые общие потоки ». Более подробную информацию о цепочках API-прокси см. в разделе «Объединение API-прокси» .
Отладку прокси-сервера можно выполнить с помощью инструмента Trace.
Apigee Edge включает в себя инструмент трассировки, который можно использовать для изучения потока выполнения вашего API-прокси при отладке и тестировании. Инструмент визуально отображает каждый шаг выполнения API-прокси для запроса. Как и в отладчике, на каждом шаге вы можете просмотреть список значений переменных, составляющих состояние API-прокси.
Для получения дополнительной информации об отладке с помощью трассировки см. раздел «Использование инструмента трассировки» .
Ошибки API-прокси обрабатываются как сбои.
Настроив обработчик ошибок, вы можете изменить сообщение об ошибке, возвращаемое клиенту API. Обработчики ошибок позволяют контролировать сообщения об ошибках независимо от того, исходит ли ошибка из вашего собственного кода или из включенного компонента (например, политики).
Дополнительную информацию см. в разделе «Обработка ошибок» .