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

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

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

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

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

  5. После завершения сценария развертывания перейдите в каталог sample-proxy. В каталоге 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 зависит от конкретных форматов сообщений, поэтому прокси-серверам могут потребоваться дополнительные изменения конфигурации.