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 maggiori informazioni, consulta la sezione Creazione di flussi condivisi riutilizzabili.

Struttura della directory del bundle di flusso condiviso

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

Struttura della directory del bundle di flusso condiviso

La configurazione di un 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 di Apigee.
Risorse Script, file JAR e file YAML a cui fanno riferimento i criteri per eseguire 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 suo nome è il nome del bundle.

/sharedflowbundle/traffic-management-shared.xml

La configurazione di base definisce i contenuti del bundle di flussi condiviso, 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 bundle di flusso condiviso, che deve essere univoco all'interno di un'organizzazione. I caratteri validi includono: A-Za-z0-9_- N/A Sì
revision Numero di revisione della configurazione del bundle di flussi condiviso. Non è necessario impostare esplicitamente il numero di revisione poiché Apigee monitora automaticamente la revisione corrente del flusso condiviso. N/A No

Elementi di configurazione di base

Nome Descrizione Predefinito Obbligatorio?
SharedFlowBundle
ConfigurationVersion Versione dello schema di configurazione del bundle di flussi condiviso a cui è conforme questo flusso condiviso. L'unico valore attualmente supportato è majorVersion 4 e minorVersion 0. Questa impostazione può 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 condiviso e 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/A No
DisplayName Nome facile da usare che può essere diverso dall'attributo name della configurazione del flusso condiviso. N/A No
LastModifiedAt e LastModifiedBy Data/ora (in epoch time) in cui il pacchetto di flussi condiviso è stato modificato per l'ultima volta, insieme all'email dell'utente che lo ha modificato.
Policies 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 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 Apigee. Si tratta semplicemente di un'impostazione manifest, progettata per fornire visibilità sui contenuti del flusso condiviso. N/A No
SharedFlows Flusso condiviso contenuto in questo bundle. 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 disponibili per il collegamento al flusso condiviso nel bundle. I criteri condividono un sottoinsieme di elementi, anche se questo sottoinsieme è integrato con elementi specifici del criterio. Per saperne di più su come configurare un criterio, consulta la pagina Panoramica dei riferimenti ai criteri.

Risorse

/sharedflowbundle/resources

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

Consulta Gestione delle risorse per conoscere i tipi di risorse supportati.

Flussi condivisi

/sharedflowbundle/sharedflows/default.xml

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

La seguente configurazione 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 all'inizio e un criterio di FlowCallout 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 del flusso condiviso

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/A 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 flusso condiviso. N/A No

Elementi di configurazione dei flussi condivisi

Nome Descrizione Predefinito Obbligatorio?
SharedFlow Sequenza di criteri nel flusso condiviso. N/A Sì
Step Fase della sequenza del flusso. N/A Sì
Name Nome dell'elemento a cui fa riferimento il passaggio. Il valore di questo elemento deve corrispondere all'identificatore univoco dell'elemento, ad esempio il valore dell'attributo del nome di un criterio. N/A Sì