Utiliser le module apigee-access

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

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

Obtenir apigee-access

Le module apigee-access est intégré à la plate-forme Apigee Edge. Lorsque vous déployez du code Node.js sur Edge, ce module est disponible. Il vous suffit de l'exiger dans n'importe quel 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 quelle variable de flux "prête à l'emploi" compatible, aux variables de flux créées par des règles et à toutes les variables de flux 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 à partir de votre code Node.js. Pour en savoir plus, consultez Accéder au cache dans Node.js.

Utiliser le service de quota

Le module apigee-access vous permet d'accéder au service de quota Apigee Edge à partir de votre code Node.js. Pour en savoir plus, consultez Accéder au service de quota dans Node.js.

Accéder aux mappages clé-valeur

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

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

Pour prendre en charge le développement et les tests locaux, le module apigee-access fonctionne en mode local sans dépendance à Apigee Edge. Toutefois, lorsque le module est utilisé avec un proxy d'API déployé sur Edge, la fonctionnalité "locale" est remplacée par une fonctionnalité Edge native. Par exemple, l' ensemble complet des variables de flux est accessible en mode déployé, tandis que seul un petit sous-ensemble est disponible lorsque vous exécutez l'application Node.js en local. Pour obtenir la liste de ces variables en mode local, consultez Exécution en mode local.

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

Pour déterminer le mode d'exécution d'apigee-access :

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

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

• apigee : l'application Node.js s'exécute sur Apigee Edge et toutes les fonctionnalités sont compatibles.
• standalone : l'application Node.js s'exécute en dehors de l'environnement Apigee Edge et la fonctionnalité par défaut décrite en haut du document prend effet.

Exécution 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 par les règles suivantes dans le flux du proxy.

Vous trouverez le lien des variables compatibles dans la documentation de référence sur les variables. Ces variables, ainsi que toutes celles que vous créez avec vos propres noms, sont visibles par apigee-access. Note que certaines variables sont en lecture seule. Elles sont identifiées dans la documentation de référence sur les variables.

Exécution 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 dans votre code Node.js code. Ce tableau présente le petit sous-ensemble de variables de flux disponibles. Ces variables sont compatibles ici afin de prendre en charge le développement et les tests locaux des applications Node.js pour Apigee Edge.

Encore une fois, sur la plate-forme Apigee Edge, un ensemble beaucoup plus important de variables prédéfinies est compatible. Pour obtenir la liste complète, consultez la documentation de référence sur les variables Apigee Edge.