Riferimento per la configurazione del bundle di flussi condivisi

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Un flusso condiviso è una funzionalità riutilizzabile simile a un proxy API. Per ulteriori informazioni, consulta Creare flussi condivisi riutilizzabili.

Struttura della directory del bundle di flussi condivisi

La struttura della directory del pacchetto di flussi condivisi, mostrata di seguito, è simile alla struttura della directory di configurazione del proxy API.

Struttura della directory del bundle di flussi condivisi

Una configurazione del bundle di flussi condivisi è costituita dai seguenti contenuti:

Configurazione di base Impostazioni di configurazione principali.
Norme File di configurazione in formato XML conformi agli schemi dei criteri Apigee.
Risorse Script, file JAR e file XSLT a cui fanno riferimento i criteri per eseguire la logica personalizzata.
Flussi condivisi Flussi condivisi inclusi in questo pacchetto.

Configurazione di base

Il file di configurazione di base si trova nella directory principale del bundle. Il nome è uguale al nome del pacchetto.

/sharedflowbundle/traffic-management-shared.xml

La configurazione di base definisce i contenuti del bundle di flussi condivisi, insieme alle informazioni per monitorare la cronologia delle revisioni del bundle.

<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>

Attributi di configurazione di base

Nome Descrizione Predefinito Obbligatorio?
SharedFlowBundle
name Nome del pacchetto di flussi condivisi, che deve essere univoco all'interno di un'organizzazione. I caratteri validi includono: A-Za-z0-9_- N/D Sì
revision Numero di revisione della configurazione del bundle di flussi condivisi. Non è necessario impostare esplicitamente il numero di revisione poiché Apigee monitora automaticamente la revisione corrente del flusso condiviso. N/D No

Elementi di configurazione di base

Nome Descrizione Predefinito Obbligatorio?
SharedFlowBundle
ConfigurationVersion Versione dello schema di configurazione del bundle di flussi condivisi a cui è conforme questo flusso condiviso. Al momento, l'unico valore supportato è majorVersion 4 e minorVersion 0. Questa impostazione potrebbe essere utilizzata in futuro per consentire l'evoluzione del formato del bundle di flussi condivisi. 4.0 No
CreatedAt e CreatedBy Data/ora (in epoch time) in cui è stato creato il bundle di flussi condivisi e l'email dell'utente che lo ha creato.
Description Descrizione testuale del flusso condiviso. Se fornita, la descrizione verrà visualizzata nell'interfaccia utente di Apigee. N/D No
DisplayName Nome facile da ricordare che può essere diverso dall'attributo name della configurazione del flusso condiviso. N/D No
LastModifiedAt e LastModifiedBy Data/ora (in epoch time) dell'ultima modifica del bundle di flussi condiviso, insieme all'email dell'utente che lo ha modificato.
Policies Elenco dei criteri nella directory /policies di questo flusso condiviso. Normalmente, questo elemento viene visualizzato solo quando il flusso condiviso è stato creato utilizzando l'interfaccia utente di gestione di Edge. Si tratta semplicemente di un'impostazione "manifest", progettata per fornire visibilità ai contenuti del flusso condiviso. N/D No
Resources Elenco delle risorse (JavaScript, Python, Java, XSLT) nella directory /resources di questo flusso condiviso. In genere, questo elemento viene visualizzato solo quando il flusso condiviso è stato creato utilizzando l'interfaccia utente di Apigee. Si tratta semplicemente di un'impostazione manifest, progettata per fornire visibilità ai contenuti del flusso condiviso. N/D No
SharedFlows Il flusso condiviso contenuto in questo bundle. N/D Sì

Criteri

/sharedflowbundle/policies

Come in un proxy API, in un bundle di flussi condivisi la directory /policies contiene il file XML di configurazione di tutti i criteri disponibili da associare al flusso condiviso nel bundle. I criteri condividono un sottoinsieme di elementi, anche se questo sottoinsieme è integrato con elementi specifici del criterio. Per scoprire di più su come configurare un criterio, consulta la Panoramica del riferimento ai criteri.

Risorse

/sharedflowbundle/resources

Le risorse sono script, codice e trasformazioni XSL che possono essere collegate ai flussi condivisi utilizzando i criteri. Questi vengono visualizzati nella sezione Script dell'editor del flusso condiviso nell'interfaccia utente di gestione.

Consulta Gestire le risorse per i tipi di risorse supportati.

Flussi condivisi

/sharedflowbundle/sharedflows/default.xml

La configurazione di SharedFlow definisce la sequenza in cui devono essere eseguiti gli elementi del flusso. Gli elementi secondari <Step> dell'elemento <SharedFlow> specificano ciascuno una parte della sequenza, come una chiamata a un criterio.

La seguente configurazione di SharedFlow specifica tre criteri da eseguire in una sequenza dall'alto verso il basso (da sinistra a destra nella console di gestione), con il criterio SpikeArrest in primo luogo e un criterio FlowCallout in ultimo.

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

Attributi di configurazione dei flussi condivisi

Nome Descrizione Predefinito Obbligatorio?
SharedFlow
name Il nome del flusso condiviso, che deve essere univoco all'interno di un'organizzazione. I caratteri validi includono: A-Za-z0-9_- N/D Sì
revision Numero di revisione della configurazione del flusso condiviso. Non è necessario impostare esplicitamente il numero di revisione poiché Apigee monitora automaticamente la revisione corrente del relativo flusso condiviso. N/D No

Elementi di configurazione dei flussi condivisi

Nome Descrizione Predefinito Obbligatorio?
SharedFlow Sequenza di criteri nel flusso condiviso. N/D Sì
Step Fase nella sequenza del flusso. N/D Sì
Name Nome dell'elemento a cui fa riferimento il passaggio. Il valore di questo elemento deve essere uguale all'identificatore univoco dell'elemento, ad esempio il valore dell'attributo name di una norma. N/D Sì