Lista próbek

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

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

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

Nauka przez działanie

Chcesz szybko zacząć pracę i zbudować solidną bazę wiedzy o Apigee Edge? W GitHubie mamy bibliotekę przykładów "learn-edge", które umożliwiają szybkie wdrażanie, wywoływanie, i śledzenie niektórych przykładowych proxy. Zacznij od najprostszego proxy i przejdź do proxy które ilustrują sprawdzanie klucza API, limit, buforowanie odpowiedzi, obsługę błędów i inne funkcje.

Po sklonowaniu repozytorium i skonfigurowaniu środowiska (co zajmuje tylko kilka minut) możesz wypróbować każdy przykład w mniej niż minutę. Każdy przykład tworzy nową wersję tego samego proxy, więc w środowisku nie będzie zbyt wielu przykładów. W każdej chwili możesz przełączać wersje, ponownie wdrażać inną wersję w interfejsie zarządzania i sprawdzać kod proxy. Plik readme każdego przykładu zawiera też krótkie podsumowanie tego, co robi przykład i jak jest skonfigurowany.

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

Przykłady z przewodnika

Dostępny jest zestaw przykładów dotyczących tematów z przewodnika po proxy interfejsów API.

Nazwa	Opis	Typy zasad	Zasoby
javascript-cookbook	Pokazuje prosty fragment kodu JavaScript, który dodaje nagłówki HTTP z zmiennych, przekształca raport pogodowy w formacie XML z JSON na XML i przycina treść dla klientów mobilnych.	JavaScript XMLToJSON	minimize.js setHeaders.js
javascript-mashup-cookbook	Kompletna aplikacja JavaScript, która wywołuje publiczne interfejsy API, łączy wyniki i generuje rozszerzoną odpowiedź dla aplikacji klienckiej. (Uwaga: to proxy interfejsu API implementuje tę samą funkcję co policy-mashup, co pokazuje, że ten sam problem można rozwiązać za pomocą różnych technik).	JavaScript	MashItUp.js
java-hello	Proste wywołanie Javy „hello world”.	JavaCallout	JavaHello.java
java-cookbook	Przekształca treść i nagłówki odpowiedzi na wielkie litery.	JavaCallout	ResponseUppercase.java
java-properties	Pokazuje, jak używać właściwości w wywołaniu Javy.	JavaCallout	JavaProperties.java
java-error	Pokazuje wzorce obsługi błędów, których możesz używać w kodzie wywołania Javy.	JavaCallout	JavaError.java
policy-mashup-cookbook	Kompletna aplikacja, która używa kompozycji zasad do wywoływania 2 publicznych interfejsów API, łączy wyniki i generuje rozszerzoną odpowiedź dla aplikacji klienckiej. (Uwaga: to proxy interfejsu API implementuje tę samą funkcję co javascript-mashup, co pokazuje, że ten sam problem można rozwiązać za pomocą różnych technik).	AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON	GenerateResponse.js

Przykładowe proxy interfejsów API

Te proxy interfejsów API znajdują się w GitHubie, gdzie na stronach readme znajdziesz szczegółowe opisy przykładów. Jeśli interesuje Cię, jak działa konkretna zasada w przykładzie, w kolumnie Typy zasad poniżej znajdź interesującą Cię zasadę, a następnie kliknij nazwę przykładu w kolumnie Nazwa. (Zasady są połączone z odpowiednimi stronami referencyjnymi w dokumentacji).

Materiały referencyjne i narzędzia

Oprócz przykładów z przewodnika i przykładowych proxy w tabelach powyżej przykłady Edge GitHub zawierają też te zasoby:

Nazwa	Opis	Typy zasad	Zasoby
regex-protection	Zasada ochrony przed zagrożeniami związanymi z wyrażeniami regularnymi może chronić backendowe interfejsy API i mikrousługi przed atakami typu SQL injection.	Ochrona przed wyrażeniami regularnymi	Nie dotyczy
oauth-validate-key-secret	Implementujesz proces przyznawania hasła OAuth. Zanim wywołasz zewnętrznego dostawcę tożsamości w celu sprawdzenia danych logowania użytkownika, musisz sprawdzić klucz i tajny klucz klienta aplikacji w Edge.	OAuthV2, inne	Nie dotyczy
condition-pattern-matching	To proxy umożliwia łatwe wypróbowanie i testowanie instrukcji warunkowych w procesie proxy interfejsu API flow.	AssignMessage	Nie dotyczy
access-entity	Pokazuje, jak pobierać profile encji z magazynu danych Apigee Edge.	AssignMessage AccessEntity ExtractVariables	brak
apikey	Implementuje proste sprawdzanie klucza API.	VerifyAPIKey AssignMessage Quota	brak
async-callout	Pokazuje proste wywołanie asynchroniczne za pomocą klienta JavaScript httpClient.	JavaScript	assemble_response.js callout.js
base64encoder	Pokazuje, jak wywoływać pliki JavaScript z zasobów JavaScript w proxy interfejsów API.	AssignMessage Javascript	core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js
conditional-policy	Implementuje proste egzekwowanie zasad warunkowych. Gdy żądanie zawiera nagłówek HTTP responsetime:true, zasada wykonuje skrypt Pythona, który dodaje do wiadomości odpowiedzi zestaw danych o skuteczności jako nagłówki HTTP.	Skrypt (Python)	timer.py
dynamic-endpoint	Implementuje proste routing warunkowy w nieco bardziej złożonym scenariuszu, który definiuje 2 adresy URL i 1 trasę domyślną.	brak	brak
jira-release-notes	Jest to proxy interfejsu API używane przez zespół dokumentacji Apigee do generowania informacji o wersji z Jiry.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-mediation	Ten przykład pokazuje, jak przeprowadzić mediację poświadczeń Kerberosa w Apigee Edge.	JavaCallout	Plik JAR Javy
oauth-advanced	Kompletny, działający przykład procesu przyznawania kodu autoryzacji, w którym Apigee Edge pełni rolę serwera autoryzacji.	GenerateAccessToken GenerateAuthCode RefreshAccessToken Wiele innych...	zobacz przykładowy kod
oauth-client-credentials	Pokazuje w pełni funkcjonalny punkt końcowy tokena OAuth 2.0 skonfigurowany pod kątem przyznawania poświadczeń klienta.	GenerateAccessToken	brak
oauth-login-app	Rola wycofana. Zamiast tego zalecamy zapoznanie się z przykładem oauth-advanced.
oauth-validate-key-secret	Ilustruje technikę sprawdzania klucza i tajnego klucza klienta przed wywołaniem dostawcy tożsamości w celu sprawdzenia danych logowania użytkownika w procesie przyznawania hasła.	OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault	brak
oauth-verify-accesstoken	Pokazuje proxy interfejsu API skonfigurowane do sprawdzania tokenów dostępu OAuth 2.0 i weryfikowania limitu.	VerifyAccessToken Quota	brak
oauth10a-3legged	Pokazuje konfigurację OAuth 1.0a z 3 stronami.	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	brak
outbound-oauth	Używa interfejsu Microsoft Azure Translator API do tłumaczenia tweetów. W tym celu wykonuje wywołanie wychodzące, aby uzyskać token dostępu OAuth, a następnie buforuje token za pomocą zasad buforowania usług API , ponownie używając buforowanego tokena za każdym razem, gdy jest wykonywane wywołanie wychodzące. Zawiera też przykładową aplikację przeglądarki używaną do wywoływania proxy interfejsu API.	AssignMessage LookupCache PopulateCache Javascript	api-config.js api-token-get.js translate-query.js translate-results.js
pagination	Dzieli wiadomość odpowiedzi XML na strony na podstawie parametrów limitu i przesunięcia podanych przez klienta.	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
response-cache	Pokazuje, jak buforować prognozy pogody w Edge przez 10 minut.	ResponseCache AssignMessage	brak
simple-python	Pokazuje prosty scenariusz dołączania skryptu Pythona w odpowiedzi, który dodaje do niej wartość nagłówka.	Skrypt (Python)	setHeader.py
soap	Pokazuje transformację XSL, która przepisuje plik WSDL w odpowiedzi na żądanie z parametrem zapytania ?wsdl.	AssignMessage ExtractVariables Script (Python) XSL	calculateaddress.py fixwsdl.xsl
streaming	Pokazuje konfigurację przesyłania strumieniowego HTTP.	brak	brak
target-reroute	Pokazuje, jak używać JavaScript do dynamicznego wybierania docelowego adresu URL na podstawie treści wiadomości żądania.	ExtractVariables Javascript	rewriteTargetUrl.js
twitter-mobile-timeline	Pokazuje, jak używać JavaScript do usuwania niepotrzebnych parametrów z tweetów, co pozwala uzyskać uproszczoną oś czasu Twittera, która jest przyjazna dla urządzeń mobilnych o ograniczonych zasobach.	AssignMessage Javascript	MobileTimeline.js
twitter-oembed	Przekształca odpowiedzi osi czasu (np. z statuses/user_timeline.json) w odpowiedź oEmbed która zawiera dane osi czasu jako bogatą treść HTML.	AssignMessage JavaScript	search-oembed.js
variables	Pokazuje, jak wyodrębniać i ustawiać zmienne na podstawie treści wiadomości transportowych oraz wiadomości JSON i XML message content.	AssignMessage ExtractVariables XMLToJSON	minimize.js
xmltojson	Przekształca dane odpowiedzi z XML na JSON.	XMLToJSON JSONToXML	brak
/schemas	Pliki schematu XML, których możesz używać jako odniesienia podczas konfigurowania proxy interfejsów API, zasad, produktów API oraz profili deweloperów i aplikacji.
/tools	Zawiera narzędzie do wdrażania deploy.py, które importuje proxy interfejsu API do organizacji w Apigee Edge, a następnie wdraża je w określonym środowisku.
/org-snapshot	Narzędzie do tworzenia migawek organizacji pobiera ustawienia organizacji, w tym deweloperów, produkty API, hosty wirtualne, mapy klucz-wartość itp. Można go używać do tworzenia kopii zapasowych szczegółów organizacji lub do odkrywania ustawień w organizacji.

Apigee-127

Jeśli jesteś programistą, Apigee-127 umożliwia szybkie rozpoczęcie kodowania proxy interfejsów API za pomocą Node.js i Swaggery. Przykłady a127 znajdziesz też w GitHubie: https://github.com/apigee-127/a127-samples.

Podziel się wrażeniami

Podziel się swoimi doświadczeniami na forum dla deweloperów Apigee.