Étape 3: Utilisez une règle ExtensionCallout

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

Lors du développement d'un proxy d'API, vous pouvez rendre une extension compatible en ajoutant une règle ExtensionAppel au proxy. (Si vous avez besoin d'aide pour créer un proxy simple, consultez la section Créer votre premier proxy.)

Lorsque vous activez la prise en charge d'une extension, vous associez la règle ExtensionCallout à une extension configurée. Les paramètres de cette configuration d'extension définissent la manière dont l'extension interagit avec la ressource de backend à laquelle elle se connecte. C'est cette extension spécifiquement configurée que la règle ExtensionCallout intègre dans le proxy d'API.

Pour ajouter une extension à votre proxy d'API:

  1. Ouvrez votre proxy d'API dans la vue Develop (Développer) de la console Apigee Edge.

    Bien que vous deviez être administrateur de l'organisation pour créer une extension, n'importe quel rôle utilisateur peut ajouter l'extension à un proxy d'API.

  2. Dans le volet Navigator (Navigateur), sélectionnez PreFlow.

  3. En haut à droite, cliquez sur le bouton + Étape pour ajouter une règle.

  4. Dans la boîte de dialogue Add Step (Ajouter une étape), dans la liste des règles sur le côté gauche, cliquez sur Extension Callout (Appel d'extension).

    Si vous ne voyez pas la stratégie ExtensionCallout dans la liste, assurez-vous d'utiliser la nouvelle interface utilisateur Edge. En outre, Apigee Extensions n'est actuellement disponible que pour les clients Apigee Edge Cloud Enterprise.

  5. Dans le volet de droite, sélectionnez les options permettant de configurer la règle:
    Champ Description
    Display Name Saisissez le nom à afficher de la règle.
    Nom Saisissez le nom à utiliser pour la règle par programmation. Il doit être unique dans le proxy.
    Extension Sélectionnez l'extension à utiliser. Il s'agit de l'extension que vous avez configurée précédemment.
    Actions Sélectionnez l'action "log".
  6. Cliquez sur Add (Ajouter).
  7. Dans la vue du flux, cliquez sur la règle pour afficher son code XML de configuration.

    Lorsque vous ajoutez l'extension, vous obtenez un exemple de code XML. Notez qu'il inclut un schéma décrivant comment structurer la configuration de l'élément <Input>. Vous pouvez ignorer le schéma de l'élément <Output>. L'action "log" de l'extension ne renvoie aucun corps de réponse.

  8. Modifiez le fichier XML de votre stratégie pour qu'il se présente comme suit :
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Extension-Callout-Beta-1">
      <DisplayName>Logging Extension</DisplayName>
      <Connector>my-logging-extension</Connector>
      <Action>log</Action>
      <Input>{
        "logName": "example-log",
        "metadata": {
          "resource": {
            "type": "global",
            "labels": {
              "project_id": "my-gcp-project"
            }
          }
        },
        "message": "This is a test"
      }</Input>
    </ConnectorCallout><!--
    Input JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"logName":{"type":"string"},"metadata":{"type":"string"},"message":{"type":"string"}},"required":["logName","message"]}
    -->
    <!--
    Output JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"content":{"type":"string"}},"required":[]}
    -->

    Ici, <Input> définit ce qui suit:

    • logName est le nom du journal dans lequel écrire. Si elle n'existe pas, elle sera créée par l'extension.
    • metadata spécifie les informations que vous pouvez utiliser pour rechercher le journal dans la console Stackdriver.
    • message est simplement le message de journal que vous souhaitez écrire.
  9. Cliquez sur le bouton Enregistrer.

Étape suivante

Étape 1 Étape 2 Étape 3 Étape 4: Déployez le proxy Étape 5