Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację
Apigee X. info
W tym artykule znajdziesz podstawowe cechy proxy interfejsów API oraz linki do dodatkowych informacji.
Interfejsy API to punkty wejścia, które umożliwiają jednej aplikacji korzystanie z funkcji innej aplikacji. Proxy interfejsów API implementujesz, aby tworzyć interfejsy API.
W Apigee Edge proxy interfejsów API implementujesz, konfigurując logikę proxy interfejsu API jako sekwencję kroków wykonywanych w odpowiedzi na żądanie z kodu klienta. Udostępniasz proxy interfejsu API klientom definiując punkty końcowe, które zawierają adres URL ze ścieżkami zasobów, czasownik HTTP, wymagania dotyczące treści, i tak dalej.
Mimo że nazywa się to proxy interfejsu API, z perspektywy kodu klienta jest to interfejs API.
Ogólne informacje o proxy interfejsów API znajdziesz w artykule Informacje o interfejsach API i proxy interfejsów API.
Kolejność logiki proxy interfejsu API określasz za pomocą przepływów
W każdej aplikacji dane przepływają przez nią zgodnie z logiką warunkową. W Apigee Edge ścieżka przetwarzania składa się z przepływów. Przepływ to sekwencja etapów (lub "kroków") które składają się na ścieżkę przetwarzania proxy interfejsu API. Przepływy umożliwiają Apigee Edge stosowanie logiki i zachowań w określonych miejscach od klienta do zasobu backendu, a następnie z powrotem do klienta.
Więcej informacji o przepływach znajdziesz w artykule Kontrolowanie sposobu wykonywania proxy za pomocą przepływów.
Dostęp do danych stanu uzyskujesz za pomocą zmiennych przepływu utworzonych przez proxy interfejsów API
Proxy interfejsu API ma dostęp do zmiennych, które reprezentują stan wykonania. Dostęp do tych zmiennych możesz uzyskać z kodu XML, który konfiguruje proxy interfejsów API i zasady. Możesz też uzyskać do nich dostęp gdy rozszerzasz proxy interfejsu API za pomocą języka proceduralnego, takiego jak Java, JavaScript lub Python.
Te zmienne są przechowywane przez Apigee Edge. Niektóre z nich istnieją domyślnie, zwykle dlatego, że są wspólne dla tego, co robią proxy interfejsów API (np. dlatego, że są częścią żądania HTTP). Możesz też tworzyć własne zmienne, aby spełnić wymagania logiczne.
Więcej informacji o zmiennych znajdziesz w artykule Zarządzanie stanem proxy za pomocą zmiennych przepływu.
Możesz warunkowo wykonywać proxy interfejsów API
Podobnie jak w większości języków programowania, w proxy interfejsów API możesz warunkowo wykonywać kod. Warunki często opierają się na stanie proxy interfejsu API, do którego możesz uzyskać dostęp za pomocą zmiennych przepływu. Możesz na przykład utworzyć warunek, który sprawdza ciąg user-agent, a następnie odpowiednio przetwarza żądanie.
Więcej informacji o wykonywaniu warunkowym znajdziesz w artykule Zmienne przepływu i warunki.
Większość logiki w proxy interfejsu API implementujesz za pomocą zasad
Większość logiki dodawanej do proxy interfejsu API jest pakowana jako zasady. Zasada to komponent Apigee Edge , który zawiera logikę dotyczącą obszaru funkcjonalnego, takiego jak bezpieczeństwo lub zarządzanie ruchem. Zasadę konfigurujesz za pomocą kodu XML, który ustawia właściwości logiki bazowej. Zasady umieszczasz w sekwencji "kroków" w przepływie, aby proxy interfejsu API wykonywało logikę w najlepszej kolejności dla celów proxy.
Więcej informacji o zasadach znajdziesz w artykule Co to jest zasada?.
Możesz uwzględnić zestawy funkcji wielokrotnego użytku
Gdy proxy interfejsu API zawiera logikę, która będzie używana w wielu miejscach kodu – np. w innych proxy interfejsów API – możesz zebrać tę logikę na potrzeby wywołań z wielu miejsc. Możesz na przykład pogrupować logikę zabezpieczeń we współdzielonym przepływie, który wywołują inne proxy interfejsów API, co zmniejsza duplikowanie w proxy interfejsów API.
Więcej informacji o przepływach współdzielonych znajdziesz w artykule Przepływy współdzielone wielokrotnego użytku. Więcej informacji o łączeniu proxy interfejsów API znajdziesz w artykule Łączenie proxy interfejsów API razem.
Proxy możesz debugować za pomocą narzędzia Trace
Apigee Edge zawiera narzędzie Trace, którego możesz używać do sprawdzania przepływu wykonywania proxy interfejsu API podczas debugowania i testowania. Narzędzie wizualnie przedstawia każdy krok proxy interfejsu API, który jest wykonywany w przypadku żądania. Podobnie jak w przypadku debugera, na każdym etapie możesz wyświetlić listę wartości zmiennych, które składają się na stan proxy interfejsu API.
Więcej informacji o debugowaniu za pomocą narzędzia Trace znajdziesz w artykule Korzystanie z narzędzia Trace.
Błędy proxy interfejsu API obsługujesz jako błędy
Konfigurując obsługę błędów, możesz dostosować błąd zwracany do klienta interfejsu API. Obsługa błędów umożliwia kontrolowanie komunikatów o błędach, niezależnie od tego, czy błąd pochodzi z Twojego kodu, czy z dołączonego komponentu (np. zasady).
Więcej informacji znajdziesz w artykule Obsługa błędów.