Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
В этой статье перечислены основные характеристики прокси API и приведены ссылки на дополнительную информацию.
API – это точки входа, позволяющие одному приложению использовать возможности другого. Вы реализуете прокси API, чтобы создавать API.
В Apigee Edge прокси-серверы API реализуются путем настройки логики прокси-сервера API в виде последовательности шагов, которые выполняются в ответ на запрос от клиентского кода. Вы предоставляете клиентам доступ к прокси-серверу API, определяя конечные точки, которые включают URL с путями к ресурсам, HTTP-глагол, требования к телу и т. д.
Хотя он называется прокси-сервер API, с точки зрения клиентского кода это API.
Общую информацию о прокси API можно найти в статье Что такое API и прокси API.
Вы можете задать последовательность логики прокси-сервера API с помощью потоков.
В любом приложении данные передаются в соответствии с логикой условий. В Apigee Edge путь обработки состоит из потоков. Поток – это последовательность этапов (или шагов), составляющих путь обработки прокси API. Потоки позволяют применять логику и задавать поведение в определенных местах при передаче данных от клиента к ресурсу на сервере и обратно.
Подробнее о потоках можно узнать в статье Как управлять выполнением прокси-сервера с помощью потоков.
Доступ к данным о состоянии осуществляется через переменные потока, созданные прокси 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…
Отладка прокси-сервера с помощью инструмента трассировки
Apigee Edge включает инструмент Trace, который можно использовать для изучения потока выполнения прокси API при отладке и тестировании. Инструмент визуально представляет каждый шаг прокси-сервера API, который выполняется для запроса. Как и в отладчике, на каждом шаге можно посмотреть список значений переменных, составляющих состояние прокси API.
Подробнее о том, как отлаживать код с помощью инструмента Trace…
Ошибки прокси-сервера API обрабатываются как сбои.
Настроив обработчик ошибок, вы можете изменить сообщение об ошибке, возвращаемое API-клиенту. Обработчики ошибок позволяют контролировать сообщения об ошибках, независимо от того, где они возникли: в вашем коде или в компоненте, который вы добавили (например, в правилах).
Подробнее о том, как обрабатывать ошибки…