Verwenden des Apigee-Zugriffsmoduls

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zuApigee X wechseln. info

Mit dem Modul apigee-access können Sie aus dem Node.js-Anwendungscode auf API-Proxy-Ablaufvariablen und -Caches zugreifen. Das Modul ist in der Apigee Edge-Plattform enthalten. Sie müssen es nicht wie andere Node.js-Module installieren.

apigee-access abrufen

Das Modul apigee-access ist in die Apigee Edge-Plattform integriert. Wenn Sie Node.js-Code in Edge bereitstellen, ist dieses Modul für Sie verfügbar. Sie müssen es nur in jedem Node.js-Code anfordern, den Sie bereitstellen. Beispiel:

var access=require('apigee-access');

Auf Ablaufvariablen zugreifen

Wenn Sie eine Node.js-Anwendung in Edge bereitstellen, können Sie aus Ihrem Node.js-Code auf alle unterstützten sofort einsatzbereiten Ablaufvariablen, auf von Richtlinien erstellte Ablaufvariablen und auf alle Ablaufvariablen zugreifen, die Sie selbst erstellen. Ablaufvariablen werden im Kontext eines API-Proxys erstellt und sind nur in diesem Kontext verfügbar, wenn er in Edge ausgeführt wird. Weitere Informationen finden Sie unter Auf Ablaufvariablen in Node.js zugreifen.

Auf den Cache zugreifen

Mit dem apigee-access Modul können Sie aus Ihrem Node.js-Code auf den verteilten Cache von Apigee Edge zugreifen. Weitere Informationen finden Sie unter Auf den Cache in Node.js zugreifen.

Kontingentdienst verwenden

Mit dem apigee-access Modul können Sie aus Ihrem Node.js-Code auf den Kontingentdienst von Apigee Edge zugreifen. Weitere Informationen finden Sie unter Auf den Kontingentdienst in Node.js zugreifen.

Auf Schlüssel/Wert-Paar-Zuordnungen zugreifen

Mit dem Modul apigee-access können Sie aus Ihrem Node.js-Code auf Schlüssel/Wert-Paar-Zuordnungen (Key Value Maps, KVMs) von Apigee Edge zugreifen. Weitere Informationen finden Sie unter Auf Schlüssel/Wert-Paar-Zuordnungen in Node.js zugreifen.

Lokaler Modus im Vergleich zum Bereitstellungsmodus

Zur Unterstützung der lokalen Entwicklung und Tests funktioniert das Modul apigee-access in einem lokalen Modus ohne Abhängigkeiten von Apigee Edge. Wenn das Modul jedoch mit einem API-Proxy verwendet wird, der in Edgebereitgestellt wird, wird die lokale Funktion durch die native Edge-Funktion ersetzt. Im Bereitstellungsmodus sind beispielsweise alle Ablaufvariablen verfügbar, während im lokalen Modus nur eine kleine Teilmenge verfügbar ist. Eine Liste dieser Variablen im lokalen Modus finden Sie unter Im lokalen Modus ausführen.

Modus ermitteln, in dem das Modul ausgeführt wird

So ermitteln Sie, in welchem Modus apigee-access ausgeführt wird:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

Der Rückgabewert von getMode() gibt an, ob die Node.js-Anwendung in Apigee Edge bereitgestellt wird oder im Standalone-Modus ausgeführt wird. Die Methode gibt eines der folgenden beiden String Ergebnisse zurück:

• apigee : Die Node.js-Anwendung wird in Apigee Edge ausgeführt und alle Funktionen werden unterstützt.
• standalone : Die Node.js-Anwendung wird außerhalb der Apigee Edge Umgebung ausgeführt und die oben im Dokument beschriebene Standardfunktion wird verwendet.

Im Bereitstellungsmodus ausführen

Wenn sie in Edge bereitgestellt werden, sind von Richtlinien festgelegte Variablen für apigee-access sichtbar. Variablen, die von den Methoden dieses Moduls hinzugefügt oder geändert wurden, sind für nachfolgende Richtlinien in the proxy flow.

Den Link zu den unterstützten Variablen finden Sie in der Variablenreferenz. Diese Variablen, und alle, die Sie mit eigenen Namen erstellen, sind für apigee-access sichtbar. Beachten Sie , dass einige Variablen schreibgeschützt sind. Sie sind in der Variablenreferenz gekennzeichnet.

Im lokalen Modus ausführen

Im lokalen Modus führen Sie Ihren Node.js-Code außerhalb des Kontexts von Apigee Edge aus. In diesem Modus sind die meisten vordefinierten Ablaufvariablen in Ihrem Node.js Code nicht verfügbar. In dieser Tabelle ist die kleine Teilmenge der verfügbaren Ablaufvariablen aufgeführt. Diese Variablen werden hier unterstützt, um die lokale Entwicklung und Tests von Node.js-Anwendungen für Apigee Edge zu ermöglichen.

Auf der Apigee Edge-Plattform wird eine viel größere Anzahl vordefinierter Variablen unterstützt. Die vollständige Liste finden Sie in der Apigee Edge Variables Reference.