Beispielliste

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Die Apigee Edge API-Beispiele enthalten die Beispiel-API-Proxys, Richtlinien, Code und Tools, die die unten beschriebenen Funktionen der Apigee Edge API-Dienste veranschaulichen.

Eine Anleitung zur Verwendung der Beispiele finden Sie unter Beispiel-API-Proxys verwenden.

Lernen durch Ausprobieren

Sie möchten gleich loslegen und sich solide Wissensdatenbank zu Apigee Edge aneignen? Wir haben eine Bibliothek mit „learn-edge“-Beispielen in GitHub, mit der Sie einige Beispiel-Proxys schnell bereitstellen, aufrufen und verfolgen können. Beginnen Sie mit dem einfachsten Proxy und gehen Sie dann zu Proxys, die die API-Schlüsselvalidierung, Kontingente, das Caching von Antworten, die Fehlerbehandlung und mehr veranschaulichen.

Nachdem Sie das Repository geklont und Ihre Umgebung eingerichtet haben (das dauert nur wenige Minuten), können Sie jedes Beispiel in weniger als einer Minute testen. Da jedes Beispiel eine neue Version desselben Proxys erstellt, wird Ihre Umgebung nicht mit vielen Beispielen überladen. Sie können jederzeit zwischen Überarbeitungen wechseln, eine andere Überarbeitung in der Verwaltungs-UI noch einmal bereitstellen und sich den Proxycode ansehen. Die Readme-Datei für jedes Beispiel enthält außerdem einen kurzen Überblick darüber, was das Beispiel tut und wie es eingerichtet ist.

Probieren Sie es aus! https://github.com/apigee/api-platform-samples/tree/master/learn-edge

Doc-Cookbook-Beispiele

Für die API-Proxy-Cookbook-Themen wird eine Reihe von Beispielen bereitgestellt.

Name Beschreibung Richtlinientypen Ressourcen
JavaScript-Cookbook Veranschaulicht ein einfaches JavaScript-Snippet, das HTTP-Header aus Variablen hinzufügt, einen Wetterbericht im XML-Format von JSON in XML umwandelt und Inhalte für mobile Clients reduziert.

JavaScript
XMLToJSON

mini.js
setHeaders.js
javascript-mashup-cookbook Eine vollständige JavaScript-Anwendung, die öffentliche APIs aufruft, Ergebnisse kombiniert und eine angereicherte Antwort für die Client-App generiert. (Hinweis: Dieser API-Proxy implementiert die gleiche Funktionalität wie das Richtlinien-Mashup und zeigt, dass dasselbe Problem mit verschiedenen Techniken angegangen werden kann.) JavaScript MashItUp.js
Java Hello Einfache „Hello World“-Java-Callouts. JavaCallout JavaHello.java
java-cookbook Wandelt Antwortinhalt und -header in Großbuchstaben um JavaCallout
ResponseUppercase.java
java-properties Veranschaulicht die Verwendung von Eigenschaften in einem Java-Callout. JavaCallout JavaProperties.java
Java-Fehler Veranschaulicht Fehlerbehandlungsmuster, die im Java-Callout-Code verwendet werden können. JavaCallout JavaError.java
policy-mashup-cookbook Eine vollständige Anwendung, die mithilfe der Richtlinienzusammensetzung zwei öffentliche APIs aufruft, Ergebnisse kombiniert und eine angereicherte Antwort für die Client-App generiert. Hinweis: Dieser API-Proxy implementiert die gleiche Funktionalität wie das JavaScript-Mashup, was zeigt, dass dasselbe Problem mit verschiedenen Techniken behoben werden kann. AssignMessage
ServiceCallout
ExtractVariables
JavaScript
XMLToJSON
GenerateResponse.js

Beispiele für API-Proxys

Die folgenden API-Proxys befinden sich in GitHub, wobei die Readme-Seiten detaillierte Beschreibungen der Beispiele enthalten. Wenn Sie wissen möchten, wie eine bestimmte Richtlinie in einem Beispiel funktioniert, suchen Sie unten in der Spalte „Richtlinientypen“ nach der entsprechenden Richtlinie und klicken Sie dann in der Spalte „Name“ auf den Beispielnamen. Die Richtlinien sind mit den entsprechenden Referenzseiten in der Dokumentation verlinkt.

Referenzen und Tools

Zusätzlich zu den Cookbook-Beispielen und Beispiel-Proxys in den obigen Tabellen enthalten die Edge GitHub-Beispiele auch diese Ressourcen:

Name Beschreibung Richtlinientypen Ressourcen
Regex-Schutz Die Bedrohungsschutzrichtlinie für reguläre Ausdrücke kann Ihre Back-End-APIs und Mikrodienste vor SQL-Injection-Angriffen schützen.

Schutz für reguläre Ausdrücke

oauth-validate-key-secret Sie implementieren den Vorgang für die OAuth-Passwortzuweisung. Sie müssen sowohl den Anwendungs-Clientschlüssel als auch das Secret in Edge validieren, bevor Sie einen externen Identitätsanbieter aufrufen, um die Anmeldedaten des Nutzers zu validieren. OAuthV2 und andere
Abgleich von Bedingungsmustern Mit diesem Proxy können Sie bedingte Anweisungen in einem API-Proxy-Ablauf einfach testen und testen. AssignMessage
access-entity Erläutert das Abrufen von Profilen für Entitäten aus dem Apigee Edge-Datenspeicher. AssignMessage
AccessEntity
ExtractVariables
keine
apikey Implementiert die einfache Validierung von API-Schlüsseln VerifyAPIKey
AssignMessage
Kontingent
keine
async-Callout Zeigt ein einfaches asynchrones Callout mithilfe des JavaScript-httpClient. JavaScript asseset_response.js
callout.js
base64encoder Zeigt, wie JavaScript-Includes aus JavaScript-Ressourcen in API-Proxys aufgerufen werden. AssignMessage
JavaScript
Core-min.js
enc-utf16-min.js
enc-base64-min.js
EncoderAuthHeader.js
Bedingte Richtlinie Implementiert eine einfache bedingte Richtlinienerzwingung. Wenn eine Anfrage einen HTTP-Header „responsetime:true“ enthält, führt eine Richtlinie ein Python-Skript aus, das der Antwortnachricht eine Reihe von Leistungsmesswerten als HTTP-Header hinzufügt. Script (Python) timer.py
dynamic-endpoint Implementiert einfaches bedingtes Routing in einem etwas komplexeren Szenario mit zwei URLs und einer Standardroute. keine keine
jira-release-notes Dies ist der API-Proxy, der vom Apigee-Dokumentationsteam verwendet wird, um Versionshinweise aus Jira zu generieren. JSONToXML
XSL
releasenotes_api.xsl
kerberos-credential-mediation In diesem Beispiel wird gezeigt, wie die Kerberos-Vermittlung von Anmeldedaten in Apigee Edge ausgeführt wird. JavaCallout Java-JAR-Datei
oauth-advanced Ein vollständiges Arbeitsbeispiel für den Vorgang des Autorisierungscode-Zuweisungstyps mit Apigee Edge als Autorisierungsserver.

GenerateAccessToken
GenerateAuthCode
RefreshAccessToken

Viele weitere...

Beispielcode ansehen
oauth-client-credentials Zeigt einen voll funktionsfähigen OAuth 2.0-Tokenendpunkt, der für den Berechtigungstyp der Clientanmeldedaten konfiguriert ist. GenerateAccessToken keine
oauth-login-app Veraltet. Wir empfehlen, stattdessen das Beispiel oauth-advanced anzusehen.
oauth-validate-key-secret Veranschaulicht eine Technik zur Validierung des Schlüssels und des Geheimnisses des Clients, bevor ein Identitätsanbieter aufgerufen wird, um die Nutzeranmeldedaten im Ablauf der Passwortzuweisung zu validieren. OAuthV2
AssignMessage
ExtractVariables
ServiceCallout
RaiseFault
keine
oauth-verify-accesstoken Zeigt einen API-Proxy, der konfiguriert ist, um OAuth 2.0-Zugriffstokens und das Kontingent zu prüfen. VerifyAccessToken
Kontingent
keine
oauth10a-3legged Veranschaulicht eine dreibeinige OAuth-Konfiguration. GenerateAceessToken
GenerateRequestToken
ServiceCallout
VerifyAccessToken
keine
outbound-oauth Verwendet die Microsoft Azure Translator API zum Übersetzen von Tweets. Dazu wird ein ausgehender Aufruf durchgeführt, um ein OAuth-Zugriffstoken abzurufen, und das Token dann mithilfe der Cache-Richtlinien der API-Dienste im Cache speichern, wobei das im Cache gespeicherte Token bei jedem ausgehenden Aufruf wiederverwendet wird. Enthält auch eine Demonstrations-Browser-App, die zum Aufrufen des API-Proxys verwendet wird. AssignMessage
LookupCache
PopulateCache
JavaScript
api-config.js
api-token-get.js
translate-query.js
translate-results.js
Seitenumbruch Paginiert eine XML-Antwortnachricht anhand der vom Client angegebenen limit- und offset-Parameter AssignMessage
ExtractVariables
ResponseCache
VerifyApiKey
XSL
paginate.xslt
response-cache Zeigt, wie Wettervorhersagen in Edge für 10 Minuten im Cache gespeichert werden. ResponseCache
AssignMessage
keine
simple-python Veranschaulicht ein einfaches Szenario, in dem ein Python-Skript an die
-Antwort angehängt wird, durch das ein Headerwert hinzugefügt wird.
Script (Python) setHeader.py
soap Zeigt eine XSL-Transformation, die eine WSDL-Datei als Antwort auf eine Anfrage mit dem Abfrageparameter „?wsdl“ umschreibt. AssignMessage
ExtractVariables
Script (Python)
XSL
countaddress.py
fixwsdl.xsl
Streaming Zeigt eine HTTP-Streaming-Konfiguration. keine keine
target-reroute Veranschaulicht die Verwendung von JavaScript zur dynamischen Auswahl einer Ziel-URL anhand des Inhalts einer Anfragenachricht. ExtractVariables
JavaScript
rewriteTargetUrl.js
Twitter-mobile-Zeitachse Zeigt, wie mithilfe von JavaScript nicht benötigte Parameter aus Tweets entfernt werden, was zu einer optimierten Twitter-Zeitachse führt, die für Mobilgeräte mit beschränkten Ressourcen geeignet ist. AssignMessage
JavaScript
MobileTimeline.js
Twitter-Oembed Wandelt Zeitachsenantworten (z.B. von status/user_timeline.json) in eine oEmbed-Antwort um, die die Zeitachsendaten als Rich-HTML-Inhalt enthält. AssignMessage
JavaScript
search-oembed.js
Variablen Veranschaulicht das Extrahieren und Festlegen von Variablen basierend auf Transport und JSON- und XML-Nachrichteninhalten. AssignMessage
ExtractVariables
XMLToJSON
minimize.js
xmltojson Wandelt Antwortdaten von XML in JSON um. XMLToJSON
JSONToXML
keine

/schemas

XML-Schemadateien, die Sie beim Konfigurieren von API-Proxys, Richtlinien, API-Produkten sowie Entwickler- und App-Profilen als Referenz verwenden können.

/tools

Enthält das Bereitstellungstool deploy.py, das einen API-Proxy in eine Organisation in Apigee Edge importiert und dann in der angegebenen Umgebung bereitstellt.

/org-snapshot

Das Tool für den Organisations-Snapshot ruft Organisationseinstellungen wie Entwickler, API-Produkte, virtuelle Hosts, Schlüssel/Wert-Zuordnungen usw. ab. Es kann verwendet werden, um die Details einer Organisation zu sichern oder die Einstellungen in einer Organisation zu ermitteln.

Apigee-127

Wenn Sie ein Programmierer sind, können Sie mit Apigee-127 API-Proxys mit Node.js und Swagger codieren. Außerdem finden Sie a127-Beispiele auf GitHub: https://github.com/apigee-127/a127-samples.

Erlebnisse mit anderen teilen

Teilen Sie Ihre Erfahrungen im Apigee-Entwicklerforum.