Riferimento per la configurazione del bundle di flussi condivisi

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Un flusso condiviso è una funzionalità riutilizzabile simile a un proxy API. Gran parte dei contenuti di questo riferimento ti sarà familiare se hai già familiarità con i proxy API.

Se stai imparando a creare un flusso condiviso, inizia dall'argomento Flussi condivisi riutilizzabili.

Struttura del bundle di flusso condiviso

Un pacchetto di flussi condivisi è costituito dalla seguente configurazione:

Configurazione di base Impostazioni di configurazione principale. Vedi Configurazione di base.
Norme File di configurazione in formato XML conformi agli schemi dei criteri di Apigee Edge. Vedi le norme.
Risorse Script, file JAR e file YAML a cui fanno riferimento i criteri per eseguire una logica personalizzata. Vedi Risorse.
SharedFlows Flussi condivisi inclusi in questo pacchetto. Vedi Flussi condivisi.

I componenti della tabella precedente sono definiti dai file di configurazione nella seguente struttura di directory:

File di configurazione e struttura di directory di un bundle di flusso condiviso

Questa sezione illustra i file di configurazione e la struttura delle directory di un bundle di flussi condivisi.

Configurazione di base

Il file di configurazione di base si trova nella directory principale del bundle. Il suo nome è il nome del bundle.

/sharedflowbundle/traffic-management-shared.xml

La configurazione di base definisce i contenuti del bundle di flusso condiviso, insieme alle informazioni per il monitoraggio della 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 Campo obbligatorio?
SharedFlowBundle
name Il nome del pacchetto di flussi condivisi, che deve essere univoco all'interno di un'organizzazione. I caratteri che è consentito utilizzare nel nome sono limitati a quanto segue: A-Za-z0-9_- N/A Sì
revision Il numero di revisione della configurazione del pacchetto di flussi condivisi. Non è necessario impostare esplicitamente il numero di revisione, poiché Apigee Edge traccia automaticamente la revisione attuale del flusso condiviso. N/A No

Elementi di configurazione di base

Nome Descrizione Predefinito Campo obbligatorio?
SharedFlowBundle
ConfigurationVersion La versione dello schema di configurazione del bundle di flussi condivisi a cui è conforme questo flusso condiviso. Attualmente l'unico valore supportato è majorVersion 4 e minorVersion 0. Questa impostazione può essere utilizzata in futuro per consentire l'evoluzione del formato del pacchetto di flussi condivisi. 4.0 No
CreatedAt e CreatedBy La data/ora (nel fuso orario dell'epoca) in cui è stato creato il pacchetto di flussi condivisi, insieme all'email dell'utente che lo ha creato.
Description Una descrizione testuale del flusso condiviso. Se fornita, la descrizione verrà visualizzata nell'interfaccia utente di gestione perimetrale. N/A No
DisplayName Un nome facile da usare che può essere diverso dall'attributo name della configurazione del flusso condiviso. N/A No
LastModifiedAt e LastModifiedBy La data/ora (nel fuso orario del periodo) dell'ultima modifica del pacchetto di flussi condivisi, insieme all'email dell'utente che lo ha modificato.
Policies Un elenco di criteri nella directory /policies di questo flusso condiviso. Normalmente vedrai questo elemento solo quando il flusso condiviso è stato creato utilizzando l'interfaccia utente di gestione Edge. Si tratta semplicemente di un'impostazione "manifest" progettata per fornire visibilità sui contenuti del flusso condiviso. N/A No
Resources Un elenco di risorse (JavaScript, Python, Java, YAML) nella directory /resources di questo flusso condiviso. Normalmente viene visualizzato solo quando il flusso condiviso è stato creato utilizzando l'interfaccia utente di gestione perimetrale. Si tratta semplicemente di un'impostazione "manifest" progettata per fornire visibilità sui contenuti del flusso condiviso. N/A No
SharedFlows Specifica il flusso condiviso contenuto in questo pacchetto.

Tieni presente che al momento questo elemento supporta un solo flusso secondario <SharedFlow>. È possibile aggiungere un solo flusso condiviso a un bundle di flusso condiviso.

 N/A Sì

Flussi condivisi

/sharedflowbundle/sharedflows/default.xml

La configurazione SharedFlow definisce la sequenza in cui gli elementi del flusso devono essere eseguiti. Gli elementi secondari <Step> dell'elemento <SharedFlow> specificano ciascuno una parte della sequenza, ad esempio 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 di arresto per picchetto prima e un criterio sui callout di flusso per 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 Campo obbligatorio?
SharedFlow
name Il nome del flusso condiviso, che deve essere univoco all'interno di un'organizzazione. I caratteri che è consentito utilizzare nel nome sono limitati a quanto segue: A-Za-z0-9_- N/A Sì
revision Il numero di revisione della configurazione del flusso condiviso. Non è necessario impostare esplicitamente il numero di revisione, poiché Apigee Edge traccia automaticamente la revisione corrente del flusso condiviso. N/A No

Elementi di configurazione dei flussi condivisi

Nome Descrizione Predefinito Campo obbligatorio?
SharedFlow Definisce la sequenza dei criteri nel flusso condiviso. N/A Sì
Step Definisce un passaggio, una fase della sequenza del flusso. N/A Sì
Name Specifica il nome dell'elemento a cui fa riferimento il passaggio. Il valore di questo elemento deve corrispondere all'identificatore univoco dell'articolo, ad esempio il valore dell'attributo nome del criterio. N/A Sì

Criteri

/sharedflowbundle/policies

Come in un proxy API, in un bundle di flusso condiviso la directory /policies contiene il codice XML di configurazione per tutti i criteri che è possibile collegare al flusso condiviso nel bundle. I criteri condividono un sottoinsieme di elementi, anche se questo sottoinsieme è associato a elementi specifici del criterio. Per saperne di più su come configurare un criterio, consulta l'argomento relativo al criterio che ti interessa. Puoi accedere a queste informazioni anche dalla Panoramica dei riferimenti alle norme.

Risorse

/sharedflowbundle/resources

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

Vedi File di risorse per conoscere i tipi di risorse supportati.

Pubblica domande nel forum per gli sviluppatori Apigee.