Korzystanie z przykładowych serwerów proxy interfejsu API

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Wymagania wstępne

Musisz mieć konto na stronie http://enterprise.apigee.com. Możesz się zarejestrować dla konta próbnego na http://accounts.apigee.com/accounts/sign_up.

Aby korzystać z próbek, musisz też mieć:

Narzędzie	Opis
Git	Fragmenty znajdziesz w serwisie GitHub. Jeśli nie masz zainstalowanego Gita, zapoznaj się z instrukcje konfiguracji GitHub. Jeśli nie chcesz instalować Git, 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 potrzebny jest Python. Python występuje w większości Linuksa na Macu z zainstalowanym XCode, na komputerze z systemem Cygwin, a także w wielu innych miejscach. Aby uzyskać Pythona, zapoznaj się z Strona pobierania języka Python
curl	Przykładowe skrypty konfiguracji też używają curl. Upewnij się, że aplikacja curl jest zainstalowana i dostępne na Twojej ścieżce (uruchom polecenie which curl, aby sprawdzić, czy jest ono dostępne w Twoim systemie).
dos2unix	Jeśli używasz programu Cygwin w systemie Windows, może też być potrzebny dos2unix za media. (Instalator Cygwin umożliwia zainstalowanie narzędzia).

Pobierz przykłady

Aby uzyskać przykładowe pliki, użyj narzędzia git clone zgodnie z poniższym przykładem:

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

Importowanie i wdrażanie przykładowego interfejsu API serwery proxy

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

1. Po pobraniu przykładów przejdź do katalogu /setup zgodnie z poniższym przykładem:

   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 elemencie setenv.sh wykonaj to polecenie:

   sh deploy_all.sh

   Ten skrypt wdraża w organizacji wszystkie przykłady serwerów proxy interfejsów API. (Ten proces zajmuje 3–4 tygodnie minutes.) Postępuj zgodnie z instrukcjami, aby wdrożyć usługi API, deweloperów i aplikacje (które są używane OAuth).

5. Po zakończeniu działania skryptu wdrażania przejdź do katalogu sample-serwery proxy. W sample-proxies, dla każdego przykładowego serwera proxy będzie dostępny jeden katalog. W każdym jest plikiem README.md z informacjami o uruchomieniu przykładu i 2 skryptach, które pomagają w wprowadzaniu niewielkich zmian w przykładach, wdrażaniu i wywoływaniu przykładu, aby sprawdzić, jaki efekt przyniosła zmiana:
   • invoke.sh: uruchom ten skrypt, aby wywołać wdrożoną wersję interfejsu API serwera proxy.
   • deploy.sh: uruchom ten skrypt, aby wdrożyć serwer proxy interfejsu API po utworzeniu zmian.

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

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

W katalogu /sample-proxies/proxy_name uruchom polecenie :

sh invoke.sh

Powoduje to wywołanie serwera proxy, który działa w środowisku testowym w organizacji.

Rozwiązywanie problemów

Tutaj znajdziesz informacje na temat rozwiązywania problemów:

• Wprowadzenie do rozwiązywania problemów
• Rozwiązywanie problemów z systemami Windows i Cygwin

Modyfikowanie i ponowne wykorzystywanie przykładowych serwerów proxy interfejsu API

Typowe użycie przykładowych serwerów proxy jest związane z ich modyfikowaniem, wdrażaniem i wywoływaniem. Dzięki temu możesz: niewielkie modyfikacje, a następnie sprawdzenie ich wpływu na treść odpowiedzi.

Aby zmodyfikować przykładowy serwer proxy interfejsu API tak, aby wskazywał inną usługę backendu, zmodyfikuj pliku 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 ustawienie 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/, zmień konfigurację na 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 zgodnie z tym przykładem:

sh deploy.sh

Aby można było korzystać z funkcji serwera proxy API, inne serwery proxy API można zmodyfikować w ten sam sposób z dotychczasowymi usługami docelowymi. W niektórych przypadkach działanie serwera proxy interfejsu API zależy jednak od w określonych formatach wiadomości, dlatego serwery proxy mogą wymagać dodatkowych zmian konfiguracji.