Как использовать примеры прокси API

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

Требования

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

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

Инструмент Описание
Git Примеры находятся на 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 установлен и доступен в вашем пути (выполните команду 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. Измените этот файл, чтобы указать организацию, адрес электронной почты, связанный с вашим именем пользователя, и среду (prod или test), в которой вы хотите развернуть прокси 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 зависит от определенных форматов сообщений, поэтому прокси-серверы могут требовать дополнительных изменений конфигурации.