Lista próbek

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

Przykłady interfejsu Apigee Edge API zawierają przykładowe serwery proxy, zasady, kod i narzędzia interfejsu API, które ilustrują możliwości usług Apigee Edge API opisane poniżej.

Instrukcje korzystania z przykładów znajdziesz w artykule Korzystanie z przykładowych serwerów proxy interfejsu API.

Ucz się przez praktykę

Chcesz pobrudzić ręce i zacząć budować solidną bazę wiedzy na temat Apigee Edge? Na GitHubie mamy bibliotekę przykładów „learn-edge”, która pozwala na szybkie wdrażanie, wywoływanie i śledzenie niektórych przykładowych serwerów proxy – począwszy od najprostszego serwera proxy, a potem na serwery proxy, które ilustrują weryfikację klucza interfejsu API, limit, buforowanie odpowiedzi, obsługę błędów i nie tylko.

Gdy sklonujesz repozytorium i skonfigurujesz środowisko (zajmie to tylko kilka minut), możesz wypróbować każdą próbkę w mniej niż minutę. A ponieważ każda próbka tworzy nową wersję tego samego serwera proxy, środowisko nie będzie zaśmiecone wieloma przykładami. W dowolnej chwili możesz przełączać wersje, ponownie wdrożyć inną wersję w interfejsie zarządzania i przejrzeć kod serwera proxy. Plik Readme dla każdej próbki zawiera też krótkie podsumowanie jego działania i konfiguracji.

Spróbuj! https://github.com/apigee/api-platform-samples/tree/master/learn-edge

Próbki książek kucharskich

Udostępniamy zestaw przykładów dotyczących tematów książek kucharskich dotyczących proxy interfejsu API.

Nazwa	Opis	Typy zasad	Zasoby
javascript-książka kucharska	Demonstracja prostego fragmentu kodu JavaScript, który dodaje nagłówki HTTP ze zmiennych, przekształca raport pogodowy w formacie XML z JSON na XML i przycina treść w przypadku klientów mobilnych.	JavaScript XMLToJSON	minimum.js setHeaders.js
Poradnik: javascript-mashup	Kompletna aplikacja JavaScript, która wywołuje publiczne interfejsy API, łączy wyniki i generuje wzbogacone odpowiedzi dla aplikacji klienckiej (uwaga: ten serwer proxy interfejsu API implementuje tę samą funkcję co mashup zasad, co pokazuje, że ten sam problem można rozwiązać, korzystając z różnych technik).	JavaScript	MashItUp.js
java-hello,	Proste objaśnienie w języku Java „hello world”.	JavaCallout	JavaHello.java
java-cookbook	Konwertuje treść odpowiedzi i nagłówki na wielkie litery.	JavaCallout	ResponseUppercase.java
java-properties	Demonstracja używania właściwości w objaśnieniu Java.	JavaCallout	JavaProperties.java
java-error,	Demonstracja wzorców obsługi błędów, których można używać w kodzie objaśnień Java.	JavaCallout	JavaError.java
Policy-mashup-cookbook	Kompletna aplikacja, która używa struktury zasad do wywoływania 2 publicznych interfejsów API, łączy wyniki i generuje rozszerzone odpowiedzi dla aplikacji klienckiej. (Uwaga: ten serwer proxy interfejsu API implementuje te same funkcje co interfejs JavaScript-mashup, co pokazuje, że ten sam problem można rozwiązać, korzystając z różnych technik).	AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON	GenerateResponse.js

Przykładowe serwery proxy interfejsu API

Poniższe serwery proxy interfejsów API znajdują się w serwisie GitHub, gdzie strony Readme zawierają szczegółowe opisy przykładów. Jeśli chcesz się dowiedzieć, jak działa konkretna zasada w przykładzie, w kolumnie Typy zasad poniżej znajdź tę, która Cię interesuje, a potem kliknij przykładową nazwę w kolumnie Nazwa. Linki do tych zasad znajdziesz w dokumentacji.

Materiały referencyjne i narzędzia

Oprócz przykładów książek kucharskich i przykładowych serwerów proxy wymienionych w tabelach powyżej przykłady na brzegu GitHuba zawierają też te zasoby:

Nazwa	Opis	Typy zasad	Zasoby
regex-protection	Zasada ochrony przed zagrożeniami za pomocą wyrażeń regularnych może chronić interfejsy API i mikroserwisy backendu przed atakami wstrzykniętymi SQL.	Ochrona wyrażeń regularnych	Nie dotyczy
oauth-validate-key-secret	Zaimplementujesz proces typu uwierzytelnienia hasła przez OAuth. Musisz zweryfikować zarówno klucz klienta, jak i tajny klucz klienta aplikacji Edge przed wywołaniem zewnętrznego dostawcy tożsamości w celu zweryfikowania danych logowania użytkownika.	OAuthV2 i inne	Nie dotyczy
dopasowanie do wzorca warunków	Ten serwer proxy umożliwia łatwe testowanie i testowanie instrukcji warunkowych w procesie serwera proxy interfejsu API.	AssignMessage	Nie dotyczy
access-entity	Pokazuje, jak pobierać profile encji z magazynu danych Apigee Edge.	AssignMessage AccessEntity ExtractVariables	brak
apikey	Implementuje prostą weryfikację klucza interfejsu API	VerifyAPIKey AssignMessage Limit	brak
objaśnienie asynchroniczne	Demonstracja prostego wywołania asynchronicznego przy użyciu JavaScript httpClient.	JavaScript	as_response.js callout.js
base64encoder	Pokazuje, jak wywoływać kod JavaScript z zasobów JavaScript na serwerach proxy interfejsu API.	AssignMessage JavaScript	Core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js
zasada warunkowa	Wdrożenie prostego egzekwowania zasad warunkowych. Gdy żądanie zawiera nagłówek HTTP „Responsetime:true”, zasada uruchamia skrypt Pythona, który dodaje zestaw wskaźników wydajności do wiadomości z odpowiedzią w postaci nagłówków HTTP.	Skrypt (Python)	timer.py
dynamic-endpoint	Implementuje proste routing warunkowy w nieco bardziej złożonym scenariuszu, który określa 2 adresy URL i 1 trasę domyślną.	brak	brak
jira-release-notes	To serwer proxy interfejsu API używany przez zespół ds. dokumentów Apigee do generowania informacji o wersji z Jira.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-mediacja	Ten przykład pokazuje, jak przeprowadzić zapośredniczenie danych uwierzytelniających Kerberos w Apigee Edge.	JavaCallout	Plik JAR Javy
oauth-advanced	Kompletny, działający przykład przepływu typu uwierzytelnienia kodu autoryzacji z Apigee Edge jako serwerem autoryzacji.	GenerateAccessToken GenerateAuthCode RefreshAccessToken Wiele innych...	zobacz przykładowy kod
oauth-client-credentials	Demonstracja w pełni funkcjonalnego punktu końcowego tokena OAuth 2.0 skonfigurowana dla typu przyznania danych logowania klienta.	GenerateAccessToken	brak
oauth-login-app	Rola wycofana. Zalecamy skorzystanie z przykładu oauth-advanced.
oauth-validate-key-secret	Ilustruje metodę weryfikacji klucza i obiektu tajnego klienta przed wywołaniem dostawcy tożsamości w celu weryfikacji danych logowania użytkownika w procesie typu uwierzytelnienia hasła.	OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault	brak
oauth-verify-accesstoken	Demonstracja serwera proxy interfejsu API skonfigurowana do weryfikowania tokenów dostępu OAuth 2.0 i weryfikacji limitu.	VerifyAccessToken Limit	brak
oauth10a-3legged	Demonstracja trzyetapowej konfiguracji OAuth 1.0a.	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	brak
outbound-oauth	Do tłumaczenia tweetów używany jest interfejs Microsoft Azure translator API. W tym celu wykonuje wywołanie wychodzące w celu uzyskania tokena dostępu OAuth, a następnie zapisuje token w pamięci podręcznej przy użyciu zasad buforowania usług API, ponownie wykorzystując token z pamięci podręcznej przy każdym wywołaniu wychodzącym. Zawiera też demonstracyjną aplikację przeglądarki używaną do wywoływania serwera proxy interfejsu API.	AssignMessage LookupCache PopulateCache Javascript	api-config.js api-token-get.js translate-query.js translate-results.js
podział na strony	Dzieli wiadomość w odpowiedzi XML na strony na podstawie parametrów limitu i przesunięcia podanych przez klienta	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
pamięć podręczna odpowiedzi	Pokazuje, jak na 10 minut zapisywać w pamięci podręcznej prognozy pogody w Edge.	ResponseCache AssignMessage	brak
simple-python	Demonstruje prosty scenariusz dołączenia skryptu Pythona do odpowiedzi , który dodaje do niej wartość nagłówka.	Skrypt (Python)	setHeader.py
mydło	Demonstracja przekształcenia XSL, które przepisuje plik WSDL w odpowiedzi na żądanie z parametrem zapytania ?wsdl.	AssignMessage ExtractVariables Skrypt (Python) XSL	Computeaddress.py fixwsdl.xls
transmisja strumieniowa	Demonstracja konfiguracji strumieniowego przesyłania danych HTTP.	brak	brak
target-reroute	Demonstracja użycia JavaScriptu do dynamicznego wybierania docelowego adresu URL na podstawie treści wiadomości żądania.	ExtractVariables JavaScript	rewriteTargetUrl.js
twitter-mobile-oś czasu	Pokazuje, jak używać JavaScriptu do usuwania z tweetów niepotrzebnych parametrów, w wyniku czego oś czasu Twittera jest przyjazna dla urządzeń mobilnych z ograniczonymi zasobami.	AssignMessage JavaScript	MobileTimeline.js
twitter-oembed,	Przekształca odpowiedzi na osi czasu (np. ze stanów/user_timeline.json) w odpowiedź oEmbed, która zawiera dane osi czasu w formie sformatowanej treści HTML.	AssignMessage JavaScript	search-oembed.js
zmienne	Pokazuje, jak wyodrębniać i ustawiać zmienne na podstawie treści wiadomości w formatach transportu oraz JSON i XML.	AssignMessage ExtractVariables XMLToJSON	minimize.js
xmltojson,	Konwertuje dane odpowiedzi z XML na JSON.	XMLToJSON JSONToXML	brak
/schemas	Pliki schematu XML, których możesz używać jako plików referencyjnych podczas konfigurowania serwerów proxy interfejsu API, zasad, usług API oraz profili programistów i aplikacji.
/tools	Zawiera narzędzie do wdrażania, Deploy.py, które importuje serwer proxy interfejsu API do organizacji w Apigee Edge, a następnie wdraża go w określonym środowisku.
/org-snapshot	Narzędzie do tworzenia zrzutów organizacji pobiera ustawienia organizacji, w tym jej programistów, usługi API, hosty wirtualne, mapy klucz-wartość itp. Za jego pomocą można tworzyć kopie zapasowe szczegółów organizacji i znajdować ustawienia w organizacji.

Apigee-127

Jeśli jesteś koderem, Apigee-127 pomoże Ci w kodowaniu serwerów proxy API z użyciem środowiska Node.js i Swagger. Próbki a127 znajdziesz też na GitHubie: https://github.com/apigee-127/a127-samples.

Podziel się wrażeniami

Podziel się wrażeniami na Forum dla programistów Apigee.