Documentation de référence sur la configuration des groupes de flux partagés

Un flux partagé est une fonctionnalité réutilisable semblable à un proxy d'API. Une grande partie du contenu de cette documentation de référence vous sera familière si vous connaissez déjà les serveurs proxy d'API.

Si vous apprenez à créer un flux partagé, commencez par le sujet Flux partagés réutilisables.

Structure du groupes de flux partagés

Un groupe de flux partagé comprend la configuration suivante :

Configuration de base Paramètres de configuration principaux. Consultez la section Configuration de base.
Règles Fichiers de configuration au format XML conformes aux schémas des règles Apigee Edge. Consultez la section Règles.
Ressources Scripts, fichiers JAR et fichiers XSLT référencés par des règles pour exécuter une logique personnalisée. Accéder aux ressources.
Flux partagés Flux partagés inclus dans ce groupe. Consultez la section Flux partagés.

Les composants du tableau ci-dessus sont définis par des fichiers de configuration dans la structure de répertoires suivante :

Fichiers de configuration et structure de répertoire d'un groupe de flux partagés

Cette section explique les fichiers de configuration et la structure de répertoires d'un groupe de flux partagés.

Configuration de base

Le fichier de configuration de base se trouve dans le répertoire racine du groupe. Son nom correspond au nom du groupe.

/sharedflowbundle/traffic-management-shared.xml

La configuration de base définit le contenu du groupe de flux partagés, avec des informations permettant de suivre l'historique des révisions du groupe.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

Attributs de configuration de base

Nom Description Par défaut Obligatoire ?
SharedFlowBundle
name Nom du groupe de flux partagés, qui doit être unique au sein d'une organisation. Les caractères que vous êtes autorisé à utiliser dans le nom sont limités aux éléments suivants : A-Za-z0-9_- ND Oui
revision Numéro de révision de la configuration du groupe de flux partagés. Vous n'avez pas besoin de définir explicitement le numéro de révision, car Apigee Edge suit automatiquement la révision actuelle du flux partagé. ND Non

Éléments de configuration de base

Nom Description Par défaut Obligatoire ?
SharedFlowBundle
ConfigurationVersion Version du schéma de configuration du groupe de flux partagés auquel ce flux partagé est conforme. La seule valeur actuellement acceptée est majorVersion 4 et minorVersion 0. Ce paramètre pourra être utilisé à l'avenir pour autoriser l'évolution du format du groupe de flux partagés. 4.0 Non
CreatedAt et CreatedBy Date et heure (heure epoch) de création du lot de flux partagé, ainsi que l'adresse e-mail de l'utilisateur qui l'a créé.
Description Description textuelle du flux partagé. Si elle est fournie, la description s'affichera dans l'interface utilisateur de gestion Edge. ND Non
DisplayName Nom convivial qui peut être différent de l'attribut name de la configuration du flux partagé. ND Non
LastModifiedAt et LastModifiedBy Date et heure (heure epoch) de la dernière modification du groupe de flux partagé, ainsi que l'adresse e-mail de l'utilisateur qui l'a modifié.
Policies Liste des règles dans le répertoire /policies de ce flux partagé. En principe, vous ne verrez cet élément que lorsque le flux partagé a été créé à l'aide de l'interface utilisateur de gestion Edge. Il s'agit simplement d'un paramètre "manifest", conçu pour fournir une visibilité sur le contenu du flux partagé. ND Non
Resources Liste des ressources (JavaScript, Python, Java, XSLT) dans le répertoire /resources de ce flux partagé. En principe, vous ne verrez cet élément que lorsque le flux partagé a été créé à l'aide de l'interface utilisateur de gestion Edge. Il s'agit simplement d'un paramètre "manifest", conçu pour fournir une visibilité sur le contenu du flux partagé. ND Non
SharedFlows Spécifie le flux partagé que le groupe contient.

À l'heure actuelle, cet élément n'accepte qu'un seul enfant <SharedFlow>. Un seul flux partagé peut être ajouté à un groupe de flux partagé.

ND Oui

Flux partagés

/sharedflowbundle/sharedflows/default.xml

La configuration de SharedFlow définit la séquence dans laquelle les éléments de flux doivent être exécutés. Les éléments enfants <Step> de l'élément <SharedFlow> spécifient chacun une partie de la séquence, par exemple un appel à une règle.

La configuration SharedFlow suivante spécifie trois règles à exécuter dans une séquence de haut en bas (de gauche à droite dans la console de gestion), avec la stratégie Spike Arrest en premier et la stratégie Flow Callout en dernier.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

Attributs de configuration du flux partagé

Nom Description Par défaut Obligatoire ?
SharedFlow
name Nom du flux partagé, qui doit être unique au sein d'une organisation. Les caractères que vous êtes autorisé à utiliser dans le nom sont limités aux éléments suivants : A-Za-z0-9_- ND Oui
revision Numéro de révision de la configuration du flux partagé. Vous n'avez pas besoin de définir explicitement le numéro de révision, car Apigee Edge suit automatiquement la révision actuelle du flux partagé. ND Non

Éléments de configuration du flux partagé

Nom Description Par défaut Obligatoire ?
SharedFlow Définit la séquence des règles dans le flux partagé. ND Oui
Step Définit une étape (une étape dans la séquence du flux). ND Oui
Name Spécifie le nom de l'élément référencé par l'étape. La valeur de cet élément doit être identique à l'identifiant unique de l'élément (par exemple, la valeur d'un attribut de nom d'une règle). ND Oui

Règles

/sharedflowbundle/policies

Comme dans un proxy d'API, dans un groupe de flux partagés, le répertoire /policies contient le fichier XML de configuration pour toutes les règles disponibles à associer au flux partagé dans le groupe. Les règles partagent un sous-ensemble d'éléments, bien que ce sous-ensemble s'enrichit d'éléments propres à la règle. Pour en savoir plus sur la configuration d'une règle, consultez la rubrique correspondante. Vous pouvez également parvenir à ces rubriques à partir de la Présentation de la documentation de référence des règles.

Ressources

/sharedflowbundle/resources

Les ressources sont des scripts, du code et des transformations XSL qui peuvent être associés à des flux partagés à l'aide de règles. Celles-ci s'affichent dans la section Scripts de l'éditeur de flux partagé dans l'interface utilisateur de gestion.

Consultez la section Fichiers de ressources pour connaître les types de ressources compatibles.

Posez vos questions sur le Forum des développeurs Apigee.