Utiliser le module apigee-access

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

Le module apigee-access vous permet d'accéder aux variables de flux et aux caches du proxy d'API à partir de dans le code d'application Node.js. Ce module est inclus avec la plate-forme Apigee Edge. vous ne devez pas vous devez l'installer comme vous le feriez avec d'autres modules Node.js.

Obtenir un accès à Apigee

Le module apigee-access est intégré à la plate-forme Apigee Edge. Lorsque vous déployer du code Node.js sur Edge, vous pouvez accéder à ce module. Il vous suffit de l'exiger dans tout code Node.js que vous déployez. Exemple :

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

Accéder aux variables de flux

Lorsque vous déployez une application Node.js sur Edge, vous pouvez accéder à n'importe quel &quot;out-of-the-box&quot; les variables de flux, les variables de flux créées par des règles, et toutes les variables de flux qui que vous créez vous-même à partir de votre code Node.js. Les variables de flux sont créées et existent dans le contexte d'un proxy d'API exécuté sur Edge. Pour en savoir plus, consultez Accéder aux variables de flux dans Node.js

Accéder au cache

Le module apigee-access vous permet d'accéder au cache distribué Apigee Edge depuis votre code Node.js. Pour en savoir plus, consultez la section Accéder au cache dans Node.js.

Utiliser le service de quotas

Le module apigee-access vous permet d'accéder au service de quotas Apigee Edge à partir de votre Code Node.js. Pour en savoir plus, consultez L'accès au service de quotas Node.js

Accès aux cartes de valeurs-clés

Le module apigee-access vous permet d'accéder aux cartes clé-valeur (KVM) Apigee Edge à partir de votre code Node.js. Pour en savoir plus, consultez Accéder aux mappages de clés-valeurs Node.js

Exécuter en mode local ou en mode déployé

Pour prendre en charge le développement et les tests en local, le module apigee-access fonctionne en mode local sans dépendre d'Apigee Edge ; Toutefois, lorsque le module est utilisé avec un proxy d'API déployé pour Edge, le service "local" est remplacée par la fonctionnalité Edge native. Par exemple, Un compliment complet de variables de flux est accessible en mode déployé, alors que seul un petit sous-ensemble lorsque vous exécutez l'application Node.js localement. Pour obtenir la liste de ces variables en mode local, consultez la section Exécuter en mode local.

Déterminer le mode d'exécution du module

Pour déterminer le mode dans lequel vous exécutez apigee-access:

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

La valeur renvoyée par getMode() vous indique si l'application Node.js est déployée ou non vers Apigee Edge ou s'exécute en mode autonome. La méthode renvoie l'une de ces deux chaînes résultats:

  • apigee : l'application Node.js s'exécute sur Apigee Edge et tous les est pris en charge.
  • standalone : l'application Node.js s'exécute en dehors d'Apigee Edge et la fonctionnalité par défaut décrite en haut du document l'effet.

Exécuter en mode déployé

Lorsqu'elles sont déployées sur Edge, les variables définies par les règles sont visibles par apigee-access, et les variables ajoutées ou modifiées par les méthodes de ce module sont visibles pour les stratégies ultérieures dans le flux du proxy.

Vous trouverez le lien des variables acceptées dans Documentation de référence sur les variables Ces variables, et tous ceux que vous créez avec vos propres noms sont visibles par apigee-access. Remarque que certaines variables sont en lecture seule. Ils sont identifiés dans la section Documentation de référence sur les variables

Exécuter en mode local

En « mode local », vous exécutez votre code Node.js en dehors du contexte d'Apigee Edge. Dans ce mode, la plupart des variables de flux prédéfinies ne sont pas accessibles du code source. Ce tableau présente le petit sous-ensemble de variables de flux disponibles. Ces variables sont pris en charge ici afin de prendre en charge le développement et les tests en local des applications Node.js. pour Apigee Edge.

Variable Lecture seule Type Remarques
client.received.start.time Oui Chaîne Heure de réception de la demande
client.received.end.time Oui Chaîne Heure de réception de la demande
client.received.start.timestamp Oui Entier Heure de réception de la demande
client.received.end.timestamp Oui Entier Heure de réception de la demande

Là encore, la plate-forme Apigee Edge accepte un ensemble bien plus grand de variables prédéfinies. Reportez-vous à la section Variables d'Apigee Edge Documentation de référence pour obtenir la liste complète