Korzystanie z przykładowych serwerów proxy interfejsu API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wymagania wstępne

Musisz mieć konto na stronie http://enterprise.apigee.com. Możesz je założyć na http://accounts.apigee.com/accounts/sign_up.

Aby korzystać z przykładów, musisz też mieć:

Narzędzie	Opis
Git	Próbki znajdują się na GitHubie. Jeśli nie masz zainstalowanego Git, zapoznaj się z instrukcjami konfiguracji GitHuba. Jeśli nie chcesz instalować Gita, możesz przejrzeć pliki i pobrać plik ZIP ze strony https://github.com/apigee/api-platform-samples.
Python	Do uruchomienia narzędzia do wdrażania Apigee wymagany jest język Python. Python występuje w większości środowisk Linux, na komputerach Mac z zainstalowanym XCode, na komputerze z systemem Windows z zainstalowanym Cygwin oraz w wielu innych miejscach. Aby uzyskać Pythona, otwórz stronę pobierania dla tego języka.
curl	Przykładowe skrypty konfiguracji również korzystają z metody curl. Sprawdź, czy oprogramowanie curl jest zainstalowane i dostępne w Twojej ścieżce (uruchom polecenie which curl, aby sprawdzić, czy jest dostępne w Twoim systemie).
dos2unix	Jeśli używasz Cygwina w systemie Windows, może być też potrzebne narzędzie dos2unix. (Instalator Cygwin umożliwia zainstalowanie tego narzędzia).

Pobierz przykłady

Aby uzyskać przykładowe pliki, użyj polecenia git clone w poniższym przykładzie:

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

Importowanie i wdrażanie przykładowych serwerów proxy interfejsu API

Zaimportuj i wdróż przykłady z wiersza poleceń:

1. Po pobraniu przykładów przejdź do katalogu /setup, jak w tym przykładzie:

   cd setup

2. W katalogu /setup znajdź plik setenv.sh.
3. Edytuj ten plik, aby ustawić swoją organizację, adres e-mail powiązany z Twoją nazwą użytkownika oraz środowisko (produkcyjne lub testowe), w którym chcesz wdrożyć serwery proxy interfejsu API.
4. Po wprowadzeniu zmian w polu setenv.sh wykonaj to działanie:

   sh deploy_all.sh

   Ten skrypt wdraża wszystkie przykładowe interfejsy API interfejsów API w organizacji. (Ten proces zajmuje 3–4 minuty). Postępuj zgodnie z instrukcjami, aby wdrożyć usługi, deweloperów i aplikacje interfejsu API (używane do OAuth).

5. Po zakończeniu skryptu wdrażania przejdź do katalogu przykładowych serwerów proxy. W katalogu sample-proxies na przykładowy serwer proxy znajdziesz 1 katalog. W każdym katalogu znajduje się plik README.md z informacjami na temat uruchamiania przykładu oraz 2 skrypty ułatwiające wprowadzanie niewielkich zmian w przykładach, wdrażanie i wywoływanie przykładu w celu sprawdzenia efektu zmiany:
   • invoke.sh: uruchom ten skrypt, aby wywołać wdrożoną wersję serwera proxy interfejsu API.
   • deploy.sh: uruchom ten skrypt, aby wdrożyć serwer proxy interfejsu API po wprowadzeniu zmian.

Wywoływanie przykładowych serwerów proxy interfejsu API

Z każdym przykładowym serwerem proxy jest powiązany skrypt powłoki, który może służyć do wywoływania serwera proxy interfejsu API po jego wdrożeniu.

W katalogu /sample-proxies/proxy_name wykonaj to polecenie:

sh invoke.sh

Spowoduje to wywołanie serwera proxy działającego w środowisku testowym w organizacji.

Rozwiązywanie problemów

Informacje na temat rozwiązywania problemów znajdziesz tutaj:

• Rozwiązywanie problemów z wprowadzeniem
• Rozwiązywanie problemów z systemem Windows/Cygwin

Modyfikowanie i ponowne używanie przykładowych serwerów proxy interfejsu API

Typowe zastosowanie przykładowych serwerów proxy to modyfikowanie, wdrażanie i wywoływanie. Dzięki temu możesz wprowadzić niewielkie zmiany i sprawdzić, jaki wpływ będą miały na wiadomość z odpowiedzią.

Aby zmodyfikować przykładowy serwer proxy interfejsu API, aby wskazywał inną usługę backendu, zmodyfikuj plik konfiguracji XML w tej lokalizacji:

/apiproxy/targets/target_name.xml

Aby na przykład wskazać przykładowy klucz interfejsu API we własnej usłudze backendu, znajdź ten plik:

/apikey/apiproxy/targets/default.xml

Jeśli domyślna konfiguracja wskazuje http://mocktarget.apigee.net, na przykład:

<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>

a usługa backendu jest dostępna pod adresem http://api.myproject.com/, a następnie zmień konfigurację tak, aby wyglądała tak:

<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>

Po zapisaniu zmian wdróż serwer proxy interfejsu API w następujący sposób:

sh deploy.sh

Inne serwery proxy interfejsu API można modyfikować w ten sam sposób, aby korzystać z funkcji serwera proxy interfejsu API w odniesieniu do istniejących usług docelowych. W niektórych przypadkach działanie serwera proxy interfejsu API zależy od konkretnych formatów wiadomości, więc serwery proxy mogą wymagać dodatkowych zmian w konfiguracji.