Ajouter et configurer une extension

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Apigee Edge inclut plusieurs packages d'extensions installés. Avant de pouvoir utiliser une extension dans un proxy d'API avec une règle d'accroche d'extension, vous devez ajouter et configurer l'extension. Lorsque vous ajoutez une extension, recherchez le package d'extension qui représente la ressource externe que vous souhaitez intégrer à votre proxy d'API, ajoutez et configurez une extension à partir de ce package, puis déployez l'extension dans un environnement Edge.

Lorsque vous configurez une extension à partir d'un package d'extension, vous spécifiez des valeurs qui centrent l'interaction de l'extension avec sa ressource externe. Par exemple, lorsque vous configurez une extension Google Cloud Firestore, vous spécifiez la base de données que l'extension doit utiliser pour créer, obtenir et supprimer des documents. Chaque extension possède son propre ensemble de propriétés de configuration qui correspondent aux aspects de la ressource avec laquelle elle interagit. Pour obtenir la liste des extensions incluses, consultez Présentation de la documentation de référence sur les extensions.

Généralement, la configuration de chaque extension inclut les identifiants que l'extension doit utiliser pour s'authentifier auprès de la ressource en votre nom.

L'environnement de déploiement des extensions est élastique pour permettre l'autoscaling en fonction de la charge. Par conséquent, un déploiement d'extension sans trafic risque de ne pas disposer d'une instance disponible pour répondre aux requêtes. Ainsi, la première requête envoyée à une extension peut prendre plus de temps, le temps que l'environnement crée une instance de l'extension à utiliser.

Pour accéder à un tutoriel de démarrage, consultez le tutoriel Ajouter et utiliser une extension.

Ajouter et configurer une extension

  1. Connectez-vous à Edge, cliquez sur le menu Admin, puis sur Extensions.

    La page Extensions qui s'affiche liste toutes les extensions qui ont été configurées à partir des packages d'extensions disponibles sur le système. Si vous souhaitez afficher une extension configurée existante, vous pouvez filtrer la liste en saisissant des termes de filtrage en haut de la page.

    Au cours des prochaines étapes, vous ajouterez votre propre extension.

  2. Sur la page Extension, cliquez sur Ajouter une extension.

    La page "Sélectionner une extension" qui s'affiche permet de répartir les extensions entre celles développées par Google et celles développées par d'autres entreprises.

  3. Sous Sélectionner une extension, cliquez sur l'onglet souhaité, puis recherchez l'extension correspondant à la ressource externe à laquelle vous accédez.

    Dans la zone du package d'extension, vous pouvez cliquer sur Afficher les détails pour afficher des informations sur la version de l'extension, son auteur, etc.

  4. Cochez la case du package d'extension pour commencer à configurer une extension à partir du package.

  5. Dans la boîte de dialogue Propriétés de l'extension, saisissez un nom et une description pour l'extension, puis cliquez sur Créer.

  6. Sur la page Extension > My-Extension-Name de l'extension que vous créez, recherchez l'environnement Apigee Edge pour lequel vous souhaitez configurer l'extension.

    Une extension doit être déployée dans le même environnement que le proxy d'API qui l'utilisera.

  7. Cliquez sur la ligne correspondant à l'environnement dans la liste.

  8. Dans la boîte de dialogue Configuration, sélectionnez ou saisissez des valeurs pour configurer cette extension.

    Chaque extension possède ses propres propriétés de configuration. Pour les descriptions des propriétés, utilisez la référence de l'extension. Les références d'extension sont répertoriées dans Présentation des références d'extensions.

  9. Cliquez sur Enregistrer.

Déployer une extension

  1. Sur la page Extension > My-Extension-Name de l'extension, cliquez sur Déployer pour déployer l'extension à utiliser à partir d'un proxy d'API.

Après avoir déployé une extension: