Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Die Apigee Edge API-Beispiele enthalten 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.
Praxisnahes Lernerlebnis
Sie möchten schnell loslegen und sich ein solides Wissen über Apigee Edge aneignen? Auf GitHub finden Sie eine Bibliothek mit Beispielen, mit denen Sie schnell einige Beispiel-Proxys bereitstellen, aufrufen und erfassen können. Sie beginnen mit dem einfachsten Proxy und gehen dann zu Proxys über, die unter anderem die API-Schlüsselvalidierung, das Kontingent, das Antwort-Caching und die Fehlerbehandlung veranschaulichen.
Nachdem Sie das Repository geklont und Ihre Umgebung eingerichtet haben (was nur wenige Minuten dauert), können Sie jedes Sample in weniger als einer Minute ausprobieren. Da für jedes Sample eine neue Version desselben Proxys erstellt wird, wird Ihre Umgebung nicht mit vielen Samples überladen. Sie können jederzeit zwischen Versionen wechseln, eine andere Version in der Verwaltungsoberfläche neu bereitstellen und sich den Proxycode ansehen. Die Readme-Datei für jedes Beispiel enthält auch eine kurze Zusammenfassung der Funktionsweise und Einrichtung des Beispiels.
Probieren Sie es aus: https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Doc-Rezeptbuch – Beispiele
Für die API-Proxy-Cookbook-Themen werden eine Reihe von Beispielen bereitgestellt.
Name | Beschreibung | Richtlinientypen | Ressourcen |
---|---|---|---|
javascript-cookbook | Ein einfaches JavaScript-Snippet, das HTTP-Header aus Variablen hinzufügt, einen XML-formatierten Wetterbericht von JSON in XML umwandelt und den Inhalt für mobile Clients zuschneidet. | minimize.js setHeaders.js |
|
javascript-mashup-cookbook | Eine vollständige JavaScript-Anwendung, die öffentliche APIs aufruft, Ergebnisse kombiniert und eine angereicherte Antwort für die Clientanwendung generiert. Hinweis: Dieser API-Proxy implementiert dieselben Funktionen wie das Richtlinien-Mashup und zeigt, dass dasselbe Problem mit verschiedenen Techniken angegangen werden kann. | JavaScript | MashItUp.js |
java-hello | Einfaches Java-Callout vom Typ „Hello World“ | JavaCallout | JavaHello.java |
java-cookbook | Wandelt den Inhalt und die Header der Antwort in Großbuchstaben um. | JavaCallout |
ResponseUppercase.java |
java-properties | Hier wird gezeigt, wie Sie Attribute in einem Java-Callout verwenden. | JavaCallout | JavaProperties.java |
java-error | Hier werden Muster für die Fehlerbehandlung veranschaulicht, die Sie in Java-Callout-Code verwenden können. | JavaCallout | JavaError.java |
policy-mashup-cookbook | Eine vollständige Anwendung, die zwei Richtlinien miteinander über den Aufruf von zwei öffentlichen APIs aufruft, die Ergebnisse kombiniert und eine angereicherte Antwort für die Clientanwendung generiert. Hinweis: Dieser API-Proxy implementiert dieselbe Funktionalität wie das JavaScript-Mashup und zeigt, dass dasselbe Problem mit verschiedenen Techniken angegangen werden kann. | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
Beispiel-API-Proxys
Die folgenden API-Proxys befinden sich auf GitHub. Auf den Readme-Seiten finden Sie detaillierte Beschreibungen der Beispiele. Wenn Sie wissen möchten, wie eine bestimmte Richtlinie in einem Sample funktioniert, suchen Sie unten in der Spalte „Richtlinientypen“ nach der gewünschten Richtlinie und klicken Sie dann in der Spalte „Name“ auf den Namen des Samples. Die Richtlinien sind mit den entsprechenden Referenzseiten in den Dokumenten verknüpft.
Referenz und Tools
Zusätzlich zu den Beispielen aus dem Doc-Kochbuch und den Beispiel-Proxys in den Tabellen oben enthalten die Edge-GitHub-Beispiele auch folgende Ressourcen:
Name | Beschreibung | Richtlinientypen | Ressourcen |
---|---|---|---|
regex-Schutz | Die Richtlinie zum Schutz vor Bedrohungen durch reguläre Ausdrücke kann Ihre Back-End-APIs und ‑Microservices vor SQL-Injection-Angriffen schützen. | – | |
oauth-validate-key-secret | Sie implementieren den OAuth-Grant-Typ „Passwort“. Sie müssen sowohl den Clientschlüssel als auch das Geheimnis der Anwendung in Edge validieren, bevor Sie einen externen Identitätsanbieter aufrufen, um die Anmeldedaten des Nutzers zu validieren. | OAuthV2, andere | – |
condition-pattern-matching | Mit diesem Proxy können Sie bedingte Anweisungen in einem API-Proxy-Ablauf ganz einfach ausprobieren und testen. | AssignMessage | – |
access-entity | Hier erfahren Sie, wie Sie Profile für Entitäten aus dem Apigee Edge-Datenspeicher abrufen. | AssignMessage AccessEntity ExtractVariables |
keine |
apikey | Implementiert eine einfache API-Schlüsselüberprüfung | VerifyAPIKey AssignMessage Quota |
keine |
async-callout | Hier wird ein einfaches asynchrones Callout mit dem JavaScript-httpClient veranschaulicht. | JavaScript | assemble_response.js callout.js |
base64encoder | Hier wird gezeigt, wie JavaScript-Includes aus JavaScript-Ressourcen in API-Proxys aufgerufen werden. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
conditional-policy | Implementiert eine einfache bedingte Richtlinienerzwingung. Wenn eine Anfrage den HTTP-Header „responsetime:true“ enthält, wird in einer Richtlinie ein Python-Script ausgeführt, 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, in dem zwei URLs und eine Standardroute definiert werden. | keine | keine |
jira-release-notes | Dies ist der API-Proxy, mit dem das Apigee-Dokumentationsteam Release-Notes aus Jira generiert. | JSONToXML XSL |
releasenotes_api.xsl |
kerberos-credential-mediation | In diesem Beispiel wird gezeigt, wie die Kerberos-Anmeldedatenvermittlung in Apigee Edge durchgeführt wird. | JavaCallout | Java-JAR-Datei |
oauth-advanced | Ein vollständiges, funktionierendes Beispiel für den Ablauf des Autorisierungscodes mit Apigee Edge als Autorisierungsserver. |
GenerateAccessToken und viele andere… |
Beispielcode ansehen |
oauth-client-credentials | Hier sehen Sie einen voll funktionsfähigen OAuth 2.0-Tokenendpunkt, der für den Berechtigungstyp „Clientanmeldedaten“ konfiguriert ist. | GenerateAccessToken | keine |
oauth-login-app | Verworfen. Wir empfehlen stattdessen das Beispiel oauth-advanced. | ||
oauth-validate-key-secret | Hier wird eine Methode zur Validierung des Schlüssels und des Secrets des Clients veranschaulicht, bevor ein Identitätsanbieter aufgerufen wird, um die Nutzeranmeldedaten im Ablauf des Passwortgranttyps zu validieren. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
keine |
oauth-verify-accesstoken | Hier sehen Sie einen API-Proxy, der zum Validieren von OAuth 2.0-Zugriffstokens und zum Überprüfen des Kontingents konfiguriert ist. | VerifyAccessToken Quota |
keine |
oauth10a-3legged | Veranschaulicht eine dreibeinige OAuth-Konfiguration. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
keine |
outbound-oauth | Hier wird die Microsoft Azure Übersetzer API für die Übersetzung von Tweets verwendet. Dazu wird ein ausgehender Aufruf getätigt, um ein OAuth-Zugriffstoken zu erhalten. Das Token wird anschließend mithilfe der Caching-Richtlinien der API-Dienste gespeichert. Dabei wird das im Cache gespeicherte Token bei jedem ausgehenden Aufruf noch einmal verwendet. Enthält auch eine Demoanwendung, 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 | Eine XML-Antwortnachricht wird basierend auf den vom Client bereitgestellten Grenz- und Offset-Parametern paginiert. | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
response-cache | Hier wird gezeigt, wie Wettervorhersagen in Edge für 10 Minuten im Cache gespeichert werden. | ResponseCache AssignMessage |
keine |
simple-python | Hier wird ein einfaches Szenario veranschaulicht, bei dem ein Python-Script an die -Antwort angehängt wird, um ihr einen Headerwert hinzuzufügen. |
Script (Python) | setHeader.py |
soap | Hier wird eine XSL-Transformation veranschaulicht, die eine WSDL-Datei in Antwort auf eine Anfrage mit dem Abfrageparameter ?wsdl neu schreibt. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
Streaming | Veranschaulicht eine HTTP-Streamingkonfiguration. | keine | keine |
target-reroute | Hier wird gezeigt, wie mit JavaScript eine Ziel-URL dynamisch anhand des Inhalts einer Anfragenachricht ausgewählt wird. | ExtractVariables JavaScript |
rewriteTargetUrl.js |
twitter-mobile-timeline | Hier wird gezeigt, wie mit JavaScript unnötige Parameter aus Tweets entfernt werden, um eine optimierte Twitter-Zeitleiste zu erhalten, die für ressourcenbeschränkte Mobilgeräte geeignet ist. | AssignMessage JavaScript |
MobileTimeline.js |
twitter-oembed | Wandelt Zeitachsenantworten (z.B. von statuses/user_timeline.json) in eine oEmbed-Antwort um, die die Zeitachsendaten als Rich-HTML-Inhalte enthält. | AssignMessage JavaScript |
search-oembed.js |
variables | Veranschaulicht, wie Variablen basierend auf Transport-, JSON- und XML-Nachrichteninhalten extrahiert und festgelegt werden. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
xmltojson | Konvertiert Antwortdaten von XML in JSON. | XMLToJSON JSONToXML |
keine |
|
XML-Schemadateien, die Sie als Referenz verwenden können, wenn Sie API-Proxys, Richtlinien, API-Produkte sowie Entwickler- und App-Profile konfigurieren. |
||
|
Enthält das Bereitstellungstool „deploy.py“, mit dem ein API-Proxy in eine Organisation in Apigee Edge importiert und dann in der angegebenen Umgebung bereitgestellt wird. |
||
|
Mit dem Tool für Organisations-Snapshots können Sie die Einstellungen einer Organisation abrufen, z. B. Entwickler, API-Produkte, virtuelle Hosts und Schlüssel/Wert-Zuordnungen. Es kann verwendet werden, um die Details einer Organisation zu sichern oder die Einstellungen in einer Organisation zu ermitteln. |
Apigee-127
Wenn Sie Programmierer sind, können Sie mit Apigee-127 API-Proxys mit Node.js und Swagger erstellen. A127-Beispiele finden Sie auch auf GitHub: https://github.com/apigee-127/a127-samples.
Erlebnisse mit anderen teilen
Teilen Sie Ihre Erfahrungen im Apigee-Entwickler-Forum mit.