Lista próbek

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

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

Instrukcje dotyczące korzystania z przykładów znajdziesz w artykule Używanie przykładowych serwerów proxy API.

Ucz się, wykonując zadania

Chcesz szybko zacząć budować solidną bazę wiedzy na temat Apigee Edge? Na GitHub mamy bibliotekę przykładów „learn-edge”, które umożliwiają szybkie wdrażanie, wywoływanie i śledzenie przykładowych serwerów proxy, począwszy od najprostszego serwera proxy, a na tych, które ilustrują weryfikację klucza API, limity, buforowanie odpowiedzi, obsługę błędów i inne, kończąc.

Po skopiowaniu repozytorium i skonfigurowaniu środowiska (co zajmuje kilka minut) możesz wypróbować każdą próbkę w mniej niż minutę. Ponieważ każda próbka tworzy nową wersję tego samego serwera proxy, Twoje środowisko nie będzie zaśmiecone dużą liczbą próbek. W każdej chwili możesz: przełączać wersje, ponownie wdrażać inną wersję w interfejsie zarządzania i sprawdzać kod pośredniczący. Plik readme dla każdej próbki zawiera też krótki opis tego, co ona robi i jak jest skonfigurowana.

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

Przykłady książek kucharskich w Dokumentach

W tematach dotyczących poradnika proxy interfejsu API podano zestaw przykładów.

Nazwa	Opis	Typy zasad	Zasoby
javascript-cookbook	Przykładowy prosty fragment kodu JavaScript, który dodaje nagłówki HTTP z użyciem zmiennych, przekształca raport pogodowy w formacie XML z formatu JSON na XML i skraca zawartość dla klientów mobilnych.	Javascript XMLToJSON	minimize.js setHeaders.js
javascript-mashup-cookbook	Pełna aplikacja JavaScript, która wywołuje publiczne interfejsy API, łączy wyniki i generuje rozszerzoną odpowiedź dla aplikacji klienta. (Uwaga: to rozwiązanie typu proxy API implementuje tę samą funkcjonalność co mashup zasad, co pokazuje, że ten sam problem można rozwiązać, stosując różne techniki).	Javascript	MashItUp.js
java-hello	Prosty przykład wywołania w Javie.	JavaCallout	JavaHello.java
java-cookbook	Zawartość i nagłówki odpowiedzi są zamieniane na wielkie litery.	JavaCallout	ResponseUppercase.java
java-properties	Film pokazujący, 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 w języku Java.	JavaCallout	JavaError.java
policy-mashup-cookbook	Pełna aplikacja, która używa kompozycji zasad do wywołania 2 publicznych interfejsów API, łączy wyniki i generuje wzbogaconą odpowiedź dla aplikacji klienckiej. (Uwaga: to wywołanie interfejsu API przez proxy udostępnia te same funkcje co skrypt JavaScript, co pokazuje, że ten sam problem można rozwiązać, stosując różne techniki).	AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON	GenerateResponse.js

Przykładowe proxy interfejsu API

Te proxy API znajdują się na GitHub, gdzie na stronach readme znajdziesz szczegółowe opisy przykładów. Jeśli chcesz sprawdzić, jak działa dana zasada w próbce, odszukaj ją w kolumnie Typy zasad, a potem kliknij nazwę próbki 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 książki kucharskiej Dokumentów i przykładowych proxy w tabelach powyżej GitHub Edge Examples zawiera też te zasoby:

Nazwa	Opis	Typy zasad	Zasoby
regex-protection	Zasady ochrony przed zagrożeniami oparte na wyrażeniach regularnych mogą chronić interfejsy API i mikroserwisy backendu przed atakami typu SQL injection.	Ochrona przed wyrażeniami regularnymi	Nie dotyczy
oauth-validate-key-secret	wdrażasz proces przyznawania dostępu typu hasło OAuth. Przed wywołaniem zewnętrznego dostawcy tożsamości w celu zweryfikowania danych logowania użytkownika musisz zweryfikować klucz klienta aplikacji i tajny klucz aplikacji w Edge.	OAuthV2, inne	Nie dotyczy
condition-pattern-matching	Ten serwer pośredniczący umożliwia łatwe testowanie instrukcji warunkowych w przepływie serwera pośredniczącego API.	AssignMessage	Nie dotyczy
access-entity	Pokazuje, jak pobierać profile elementów z bazy danych Apigee Edge.	AssignMessage AccessEntity ExtractVariables	brak
apikey	Implementuje prostą weryfikację klucza interfejsu API.	VerifyAPIKey AssignMessage Quota	brak
async-callout	Przykład prostego wywołania asynchronicznego za pomocą JavaScript httpClient.	Javascript	assemble_response.js callout.js
base64encoder	Pokazuje, jak wywoływać include JavaScriptu z zasobów JavaScriptu w interfejsach proxy interfejsu 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 uruchamia skrypt Pythona, który dodaje do wiadomości o odpowiedzi zestaw danych o wydajności w postaci nagłówków HTTP.	Skrypt (Python)	timer.py
dynamic-endpoint	Wdrożenie prostego przekierowywania warunkowego w nieco bardziej złożonym scenariuszu, który definiuje 2 adresy URL i 1 trasę domyślną.	brak	brak
jira-release-notes	To serwer proxy interfejsu API używany przez zespół ds. dokumentacji Apigee do generowania informacji o wersji z Jira.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-mediation	Ten przykład pokazuje, jak przeprowadzić zapośredniczenie danych uwierzytelniających Kerberos w Apigee Edge.	JavaCallout	Plik JAR Javy
oauth-advanced	Pełny, działający przykład przepływu typu udzielania dostępu za pomocą kodu autoryzacji z Apigee Edge jako serwerem autoryzacji.	GenerateAccessToken GenerateAuthCode RefreshAccessToken i wiele innych.	zapoznać się z przykładowym kodem
oauth-client-credentials	Pokazuje w pełni funkcjonalny punkt końcowy tokena OAuth 2.0 skonfigurowany pod kątem typu udzielenia uprawnień danych logowania klienta.	GenerateAccessToken	brak
oauth-login-app	Rola wycofana. Zalecamy zapoznanie się z tym przykładem: oauth-advanced.
oauth-validate-key-secret	Przykład techniki weryfikacji klucza i klucza tajnego klienta przed wywołaniem dostawcy tożsamości w celu weryfikacji danych logowania użytkownika w ramach procesu udzielania dostępu typu hasło.	OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault	brak
oauth-verify-accesstoken	Przykład serwera proxy API skonfigurowanego do sprawdzania tokenów dostępu OAuth 2.0 i weryfikacji limitu.	VerifyAccessToken Limit	brak
oauth10a-3legged	Demonstracja konfiguracji OAuth 1.0a z 3 etapami.	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	brak
outbound-oauth	Do tłumaczenia tweetów używa interfejsu Microsoft Azure Translator API. W tym celu wykonuje wywołanie wychodzące, aby uzyskać token dostępu OAuth, a następnie przechowuje go w pamięci podręcznej przy użyciu zasad dotyczących pamięci podręcznej usług interfejsu API. Wykorzystuje ten token za każdym razem, gdy wykonuje wywołanie wychodzące. Zawiera też demonstracyjną aplikację przeglądarki, która służy do wywoływania proxy interfejsu API.	AssignMessage LookupCache PopulateCache Javascript	api-config.js api-token-get.js translate-query.js translate-results.js
podział na strony	dzieli na strony odpowiedź w formacie XML na podstawie parametrów limit i offset podanych przez klienta;	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
response-cache	Pokazuje, jak przechowywać w pamięci podręcznej prognozy pogody w Edge przez 10 minut.	ResponseCache AssignMessage	brak
simple-python	Przykład prostego scenariusza polegającego na dołączeniu skryptu Pythona do odpowiedzi , który dodaje do niej wartość nagłówka.	Skrypt (Python)	setHeader.py
mydło	Przykład przekształcenia XSL, które w odpowiedzi na żądanie z parametrem zapytania ?wsdl przepisuje plik WSDL.	AssignMessage ExtractVariables Skrypt (Python) XSL	calculateaddress.py fixwsdl.xsl
streaming	Przykład konfiguracji strumieniowania HTTP.	brak	brak
target-reroute	Przykład użycia kodu JavaScript do dynamicznego wybierania adresu URL docelowego na podstawie treści wiadomości z prośbą.	ExtractVariables Javascript	rewriteTargetUrl.js
twitter-mobile-timeline	Pokazuje, jak za pomocą JavaScripta usuwać z tweetów niepotrzebne parametry, dzięki czemu można 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 z osi czasu (np. z statuses/user_timeline.json) w odpowiedź o formie oEmbed, która zawiera dane z osi czasu jako rozszerzoną treść HTML.	AssignMessage JavaScript	search-oembed.js
zmiennych,	Pokazuje, jak wyodrębniać i ustawiać zmienne na podstawie transportu oraz treści wiadomości w formacie JSON i XML.	AssignMessage ExtractVariables XMLToJSON	minimize.js
xmltojson	Konwertuje dane odpowiedzi z formatu XML na format JSON.	XMLToJSON JSONToXML	brak
/schemas	pliki schematów XML, których możesz używać jako referencyjnych podczas konfigurowania serwerów proxy interfejsu API, zasad, produktów interfejsu 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 kopii zapasowej organizacji umożliwia pobieranie ustawień organizacji, w tym informacji o deweloperach, usługach API, hostach wirtualnych, mapach klucz-wartość itp. Można go użyć do utworzenia kopii zapasowej szczegółów organizacji lub do sprawdzenia ustawień organizacji.

Apigee-127

Jeśli jesteś programistą, Apigee-127 pomoże Ci zacząć kodować proksy API za pomocą Node.js i Swagger. Przykłady kodu a127 znajdziesz też na GitHubie: https://github.com/apigee-127/a127-samples.

Podziel się wrażeniami

Podziel się swoimi wrażeniami na forum dla deweloperów Apigee.