Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'Apigee Edge.
Un flux partagé est une fonctionnalité réutilisable semblable à un proxy d'API. Pour en savoir plus, consultez la page Créer des flux partagés réutilisables.
Structure du répertoire du groupe de flux partagé
La structure de répertoires du groupe de flux partagé, illustrée ci-dessous, est semblable à la structure de répertoires de configuration du proxy d'API.
Une configuration de groupe de flux partagé comprend le contenu suivant :
| Configuration de base | Paramètres de configuration principaux. |
| Règles | Fichiers de configuration au format XML conformes aux schémas des règles Apigee. |
| Ressources | Scripts, fichiers JAR et fichiers XSLT référencés par des règles pour exécuter une logique personnalisée. |
| Flux partagés | Flux partagés inclus dans ce groupe. |
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 | nécessaire |
|---|---|---|---|
SharedFlowBundle |
|||
name |
Nom du groupe de flux partagé, qui doit être unique au sein d'une organisation. Les caractères valides sont les 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 suit automatiquement la révision actuelle du flux partagé. | ND | Non |
Éléments de configuration de base
| Nom | Description | Par défaut | nécessaire |
|---|---|---|---|
SharedFlowBundle |
|||
ConfigurationVersion |
Version du schéma de configuration du groupe de flux partagés auquel ce flux partagé est conforme. Les seules valeurs actuellement acceptées sont 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/heure (heure epoch) de création du groupe de flux partagé et 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 d'Apigee. | 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 Apigee. Il s'agit simplement d'un paramètre "manifest", conçu pour fournir une visibilité sur le contenu du flux partagé. |
ND | Non |
SharedFlows |
Flux partagé contenu dans ce groupe. | 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 est enrichi d'éléments propres à la règle. Pour en savoir plus sur la configuration d'une stratégie, consultez la page de Présentation de la documentation de référence des règles.
Resources
/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.
Pour connaître les types de ressources compatibles, consultez la section Gérer les ressources.
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, telle qu'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 SpikeArrest en premier et la stratégie FlowCallout 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 | nécessaire |
|---|---|---|---|
SharedFlow |
|||
name |
Nom du flux partagé, qui doit être unique au sein d'une organisation. Les caractères valides sont les 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 suit automatiquement la révision actuelle du flux partagé. | ND | Non |
Éléments de configuration du flux partagé
| Nom | Description | Par défaut | nécessaire |
|---|---|---|---|
SharedFlow |
Séquence de stratégies dans le flux partagé. | ND | Oui |
Step |
Étape dans la séquence du flux. | ND | Oui |
Name |
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 |