Использование примеров прокси API

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

Предварительные требования

Вам потребуется учетная запись на сайте http://enterprise.apigee.com . Вы можете зарегистрироваться для получения пробной учетной записи по адресу http://accounts.apigee.com/accounts/sign_up .

Для использования образцов вам также потребуется следующее:

Инструмент Описание
Гит Примеры находятся на GitHub. Если у вас не установлен Git, пожалуйста, обратитесь к инструкциям по настройке Git на GitHub . Если вы не хотите устанавливать Git, вы можете просмотреть файлы и загрузить ZIP-архив по адресу https://github.com/apigee/api-platform-samples .
Python

Для запуска инструмента развертывания Apigee требуется Python. Python присутствует в большинстве сред Linux, на Mac с установленным Xcode, на машинах Windows с установленным Cygwin и во многих других местах.

Чтобы получить Python, пожалуйста, перейдите на страницу загрузки Python .

curl В примерах скриптов установки также используется curl . Убедитесь, что curl установлен и доступен в вашем PATH (выполните команду which curl чтобы проверить его наличие в вашей системе).
dos2unix Если вы используете Cygwin в Windows, вам также может понадобиться утилита dos2unix . (Установщик Cygwin позволяет установить эту утилиту.)

Скачайте образцы

Чтобы получить примеры файлов, используйте git clone как показано в следующем примере:

git clone https://github.com/apigee/api-platform-samples.git

Импортируйте и разверните примеры API-прокси.

Импортируйте и разверните примеры из командной строки:

  1. После загрузки примеров перейдите в каталог /setup , как показано в следующем примере: 
    cd setup
  2. В каталоге /setup найдите файл setenv.sh .
  3. Отредактируйте этот файл, чтобы указать вашу организацию, адрес электронной почты, связанный с вашим именем пользователя, и среду (производственная или тестовая), в которой вы хотите развернуть прокси-серверы API.
  4. После редактирования файла setenv.sh выполните следующее:
    sh deploy_all.sh

    Этот скрипт развертывает все примеры API-прокси в вашей организации. (Процесс занимает 3-4 минуты.) Следуйте подсказкам для развертывания API-продуктов, разработчиков и приложений (которые используются для OAuth).

  5. После завершения работы скрипта развертывания перейдите в каталог sample-proxies. В каталоге sample-proxies вы найдете отдельную директорию для каждого прокси-сервера. В каждой директории находится файл README.md с информацией о запуске примера, а также два скрипта, которые помогут вам вносить небольшие изменения в примеры, развертывать их и затем запускать, чтобы увидеть, какой эффект оказали ваши изменения:
    • invoke.sh : Выполните этот скрипт для вызова развернутой версии API-прокси.
    • deploy.sh : Выполните этот скрипт для развертывания API-прокси после внесения любых изменений.

Запустите примеры API-прокси.

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

В каталоге /sample-proxies/ proxy_name выполните следующее:

sh invoke.sh

Это запускает прокси-сервер, работающий в тестовой среде вашей организации.

Поиск неисправностей

Для получения информации по устранению неполадок см. следующие разделы:

Измените и повторно используйте примеры API-прокси.

Типичное использование примеров прокси-серверов заключается в их модификации, развертывании и вызове. Это позволяет вносить небольшие изменения, а затем наблюдать за их влиянием на ответное сообщение.

Чтобы изменить конфигурацию прокси-сервера API и перенаправить его на другой бэкэнд-сервис, измените XML-файл конфигурации, расположенный по следующему пути:

/apiproxy/targets/target_name.xml

Например, чтобы указать в примере с ключом API на ваш собственный бэкэнд-сервис, найдите следующий файл:

/apikey/apiproxy/targets/default.xml

Если конфигурация по умолчанию указывает на http://mocktarget.apigee.net , например:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Если ваш бэкэнд-сервис доступен по адресу http://api.myproject.com/ , то измените конфигурацию следующим образом:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

После сохранения изменений разверните API-прокси, как показано в следующем примере:

sh deploy.sh

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