Korzystanie z przykładowych serwerów proxy interfejsu API

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wymagania wstępne

Musisz mieć konto na stronie http://enterprise.apigee.com. Konto próbne możesz utworzyć na stronie http://accounts.apigee.com/accounts/sign_up.

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

Narzędzie Opis
Git Przykłady znajdują się w GitHubie. Jeśli nie masz zainstalowanego Gita, zapoznaj się z instrukcjami konfiguracji Gita w GitHubie. Jeśli nie chcesz instalować Gita, możesz przeglądać pliki i pobrać plik ZIP z https://github.com/apigee/api-platform-samples.
Python

Python jest wymagany do uruchomienia narzędzia do wdrażania Apigee. Python jest dostępny w większości środowisk Linux , na komputerach Mac z zainstalowanym Xcode, na komputerach z systemem Windows z zainstalowanym Cygwin i w wielu innych miejscach.

Aby pobrać Pythona, otwórz stronę pobierania Pythona .
curl Skrypty konfiguracji przykładów też używają curl. Sprawdź, czy curl jest zainstalowany i dostępny w Twojej ścieżce (uruchom polecenie which curl , aby sprawdzić, czy jest dostępny w Twoim systemie).
dos2unix Jeśli używasz Cygwin w systemie Windows, może być też potrzebne narzędzie dos2unix. (Instalator Cygwin umożliwia zainstalowanie tego narzędzia).

Pobieranie przykładów

Aby pobrać pliki przykładowe, użyj polecenia git clone, jak pokazano w tym przykładzie:

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

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

Importowanie i wdrażanie przykładów z poziomu wiersza poleceń:

  1. Po pobraniu przykładów przejdź do katalogu /setup, jak pokazano w tym przykładzie: 
    cd setup
  2. W katalogu /setup znajdź plik setenv.sh.
  3. Edytuj ten plik, aby ustawić organizację, adres e-mail powiązany z Twoją nazwą użytkownika, oraz środowisko (produkcyjne lub testowe), w którym chcesz wdrożyć proxy interfejsów API.
  4. Po edycji pliku setenv.sh wykonaj te czynności: 
    sh deploy_all.sh

    Ten skrypt wdraża wszystkie przykładowe proxy interfejsów API w Twojej organizacji. (Proces trwa 3–4 minuty). Postępuj zgodnie z instrukcjami, aby wdrożyć produkty API, deweloperów i aplikacje (które są używane w OAuth).

  5. Po zakończeniu działania skryptu wdrożenia przejdź do katalogu sample-proxies. W katalogu sample-proxies znajdziesz 1 katalog na każde przykładowe proxy. W każdym katalogu znajduje się plik README.md z informacjami o uruchamianiu przykładu oraz 2 skrypty, które pomagają wprowadzać drobne zmiany w przykładach, wdrażać je, a następnie wywoływać przykład, aby zobaczyć, jaki efekt przyniosła zmiana:
    • invoke.sh: uruchom ten skrypt, aby wywołać wdrożoną wersję proxy interfejsu API.
    • deploy.sh: uruchom ten skrypt, aby wdrożyć proxy interfejsu API po wprowadzeniu zmian.

Wywoływanie przykładowych proxy interfejsów API

Każde przykładowe proxy ma powiązany skrypt powłoki, którego można użyć do wywołania proxy interfejsu API po jego wdrożeniu.

W katalogu /sample-proxies/proxy_name wykonaj te czynności:

sh invoke.sh

Spowoduje to wywołanie proxy, które działa w środowisku testowym w Twojej organizacji.

Rozwiązywanie problemów

Informacje o rozwiązywaniu problemów znajdziesz w tych artykułach:

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

Typowe użycie przykładowych proxy polega na ich modyfikowaniu, wdrażaniu i wywoływaniu. Umożliwia to wprowadzanie drobnych zmian, a następnie sprawdzanie, jaki mają one wpływ na wiadomość z odpowiedzią.

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

/apiproxy/targets/target_name.xml

Aby na przykład skierować przykład klucza interfejsu API do własnej usługi backendu, znajdź ten plik:

/apikey/apiproxy/targets/default.xml

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

<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 Twoja usługa backendu jest dostępna pod adresem http://api.myproject.com/, zmodyfikuj 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óż proxy interfejsu API, jak pokazano w tym przykładzie:

sh deploy.sh

Inne proxy interfejsów API można modyfikować w ten sam sposób, aby używać funkcji proxy interfejsów API w istniejących usługach docelowych. W niektórych przypadkach jednak działanie proxy interfejsu API zależy od określonych formatów wiadomości, dlatego proxy mogą wymagać dodatkowych zmian w konfiguracji.