Creazione di flussi condivisi riutilizzabili

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Nota:negli ambienti abilitati per i deployment di archiviazione, non puoi gestire i flussi condivisi utilizzando la UI, l'API o gcloud di Apigee. Per gestire i flussi condivisi per i deployment di archiviazione utilizzando Apigee in VS Code, vedi anche Sviluppo di flussi condivisi utilizzando Apigee in VS Code.

Combina criteri e risorse in un flusso condiviso che puoi utilizzare da più proxy API e persino da altri flussi condivisi. Sebbene sia simile a un proxy, un flusso condiviso non ha un endpoint. Può essere utilizzato solo da un proxy API o da un flusso condiviso che si trova nella stessa organizzazione del flusso condiviso stesso.

Un flusso condiviso, che acquisisce in un unico posto funzionalità utili in più posizioni, ti aiuta a garantire la coerenza, ridurre i tempi di sviluppo e gestire più facilmente il codice.

Nota: questo video è stato registrato con una versione precedente della UI di Apigee; tuttavia, i concetti sono ancora validi.

Il seguente video mostra come creare ed eseguire il debug di un flusso condiviso nell'interfaccia utente Apigee.

Puoi chiamare un flusso condiviso utilizzando il criterio FlowCallout. Inoltre, collegando un flusso condiviso a un hook di flusso, puoi fare in modo che il flusso condiviso venga eseguito prima di una richiesta proxy o di destinazione oppure dopo una risposta proxy o di destinazione.

Per informazioni sulle norme relative a FlowCallout, consulta le norme sui callout di flusso. Per saperne di più sugli hook di flusso, vedi Collegamento di un flusso condiviso utilizzando un hook di flusso.

Ad esempio, immagina di avere aree di funzionalità utilizzate in più posizioni o che devono essere standardizzate in tutte le API della tua organizzazione. Potresti avere un flusso condiviso per ogni categoria, tra cui:

• Sicurezza, con codice di autorizzazione che utilizza OAuth e verifica della chiave API, nonché codice di protezione dalle minacce.
• Logging, per generare messaggi di errore standard.
• Mediazione, per la trasformazione tra i formati dei messaggi XML e JSON.

Nella seguente illustrazione, due proxy API chiamano (con un criterio FlowCallout) un flusso condiviso per autenticare le richieste utente in entrata. AuthSharedFlow è stato implementato separatamente nell'organizzazione prima dei proxy, in modo che sia disponibile per supportare le richieste dei proxy. Un flusso condiviso può essere sviluppato e gestito da un team responsabile delle politiche aziendali generali, quindi utilizzato nei proxy dai team di linea di business che creano app più specializzate.

Sviluppo di un flusso condiviso

Nota: gestisci gli errori dal proxy API che chiama il flusso condiviso, anziché all'interno del flusso condiviso stesso. Per saperne di più, consulta Gestione dei guasti.

Quando sviluppi un flusso condiviso, devi sempre testarlo con chiamate inviate a un proxy API. In altre parole, non puoi inviare richieste direttamente a un flusso condiviso come faresti con un proxy API. Invece, invii le richieste a un proxy API che, a sua volta, chiama il flusso condiviso.

Ecco i passaggi generali per sviluppare un flusso condiviso:

1. Definisci il set di funzionalità condivise.

   Ad esempio, potresti voler combinare le funzionalità di gestione del traffico, inclusa la soppressione dei picchi di traffico. In questo modo, puoi gestire la configurazione al di fuori del flusso di lavoro di chi implementa la logica di business.

2. Sviluppa un flusso condiviso implementando criteri e risorse di supporto, proprio come faresti quando sviluppi un proxy API.

   Un flusso condiviso è una sequenza di passaggi condizionali. Pertanto, svilupparne uno è come sviluppare un proxy API. Puoi includere norme e risorse che potresti includere in un proxy.

   Ad esempio, nell'ambito del supporto per la gestione del traffico, potresti implementare una policy Spike Arrest per consentire solo 30 richieste al secondo, come nel seguente esempio:

   <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
       <DisplayName>Spike Arrest</DisplayName>
       <Properties/>
       <Identifier ref="request.header.some-header-name"/>
       <MessageWeight ref="request.header.weight"/>
       <Rate>30ps</Rate>
   </SpikeArrest>

   Poi, a un flusso condiviso per la gestione del traffico, potresti collegare il criterio Spike Arrest come un passaggio. Il criterio verrà eseguito per qualsiasi proxy API che chiama il flusso condiviso.

   <SharedFlow name="default">
       <Step>
           <Name>Spike-Arrest</Name>
       </Step>
   </SharedFlow>

   Per informazioni su come avviare un flusso condiviso nella console di gestione, vedi Creazione di un flusso condiviso nella UI di Apigee.

   Come per i proxy API, puoi importare un file zip contenente gli artefatti di origine del flusso condiviso utilizzando l'API Create shared flow. Di seguito viene illustrato come importare un flusso condiviso con l'API Apigee:

   curl "https://apigee.googleapis.com/v1/organizations/$ORG/sharedflows?action=import&name=mySharedFlow" \
     -X POST \
     -F "file=@sharedflow.zip" \
     -H "Authorization: Bearer $TOKEN"

   Dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta la sezione Utilizzare curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

3. Esegui il deployment del flusso condiviso nell'ambiente prima di eseguire il deployment dei proxy o dei flussi condivisi che lo utilizzeranno. Il deployment di un flusso condiviso viene eseguito nello stesso modo in cui viene eseguito il deployment di un proxy API. (Per maggiori informazioni, consulta la Panoramica dell'implementazione.)

   Un flusso condiviso deve trovarsi nella stessa organizzazione ed essere sottoposto a deployment nello stesso ambiente dei proxy API e degli altri flussi condivisi che lo utilizzano. Il deployment del flusso condiviso prima dei proxy consente di risolvere la dipendenza del proxy dal flusso condiviso al momento del deployment.

   Puoi eseguire il deployment di un flusso condiviso con una chiamata API Apigee come la seguente:

   curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/sharedflows/$SHAREDFLOW/revisions/$REV/deployments \
     -X POST \
     -H "Authorization: Bearer $TOKEN"

   Analogamente ai proxy API, tutti i deployment di flussi condivisi riusciti su Apigee sono deployment senza tempi di inattività.

4. Sviluppa il proxy API di consumo in modo che possa chiamare il flusso condiviso come parte del proprio flusso.

   Da un proxy API, chiami un flusso condiviso con un criterio FlowCallout. Puoi anche collegare il flusso condiviso al proxy utilizzando un flow hook.

   Per utilizzare un flusso condiviso, aggiungi un criterio FlowCallout al proxy o al flusso condiviso che lo utilizzerà. Come un criterio di callout del servizio, con cui chiami un altro servizio, un FlowCallout chiama il flusso condiviso. Il proxy API di consumo deve essere sottoposto a deployment dopo il flusso condiviso e nello stesso ambiente del flusso condiviso. Il flusso condiviso deve essere attivo quando vuoi testare una chiamata utilizzando il criterio FlowCallout.

   Nel seguente codice, un criterio FlowCallout chiama un flusso condiviso chiamato traffic-management-shared.

   <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
       <DisplayName>Traffic Management FlowCallout</DisplayName>
       <Properties/>
       <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
   </FlowCallout>

   Per saperne di più, consulta Chiamare un flusso condiviso da un proxy API o un flusso condiviso

5. Esegui il deployment del proxy API di consumo per iniziare a utilizzare il flusso condiviso. Per saperne di più sul deployment in generale, consulta la panoramica del deployment.
6. Sviluppa in modo iterativo eseguendo il debug, come faresti con un proxy API.

   Come per un proxy API, sviluppi un flusso condiviso richiamando ed eseguendo il debug in modo iterativo finché non ottieni la logica che desideri. In questo caso, poiché il flusso condiviso non viene eseguito autonomamente, invochi un endpoint proxy ed esegui il debug del proxy.

   Prima di iniziare i passaggi che seguono, assicurati che sia il flusso condiviso sia il proxy API che lo chiama con un criterio FlowCallout si trovino nella stessa organizzazione e siano sottoposti a deployment nello stesso ambiente.

   Apigee nella console Cloud

   1. Nella scheda Debug del proxy API, inizia il debug del proxy API.
   2. Invia una richiesta a un endpoint proxy nel proxy API. Il flusso dall'endpoint deve includere il criterio FlowCallout che chiama il flusso condiviso.
   3. Nella scheda Debug, esamina il flusso dal proxy API al flusso condiviso. Per ulteriori informazioni sul debug, vedi Strumento di debug.

   Apigee classico

   1. Nella scheda Trace del proxy API, inizia a tracciare il proxy API.
   2. Invia una richiesta a un endpoint proxy nel proxy API. Il flusso dall'endpoint deve includere il criterio FlowCallout che chiama il flusso condiviso.
   3. Nella scheda Trace, esamina il flusso dal proxy API al flusso condiviso.

      Tieni presente che nella traccia, il flusso condiviso è rappresentato come un insieme di passaggi o criteri racchiusi in una casella grigia. Le icone che rappresentano i criteri di FlowCallout precedono i flussi condivisi. Per ulteriori informazioni sul tracciamento, vedi Strumento di debug.

      

Creazione di un flusso condiviso nell'interfaccia utente Apigee

Quando utilizzi l'API Apigee per creare un flusso condiviso, puoi crearlo da zero o importando le origini del flusso esistenti come file zip del bundle di flusso.

Accedi alla pagina Flussi condivisi, come descritto di seguito. Nella pagina Flussi condivisi, puoi visualizzare un elenco dei flussi condivisi nell'organizzazione e modificare o eliminare i flussi nell'elenco.

Per creare un flusso condiviso nell'interfaccia utente Apigee:

Apigee nella console Cloud

1. Nella console Google Cloud , vai alla pagina Sviluppo proxy > Flussi condivisi.

   Vai a Flussi condivisi

2. Seleziona l'organizzazione che contiene il flusso condiviso. Vedi Passare da un'organizzazione all'altra.

   Il flusso condiviso sarà disponibile per tutti i proxy API e i flussi condivisi di cui è stato eseguito il deployment in un ambiente di questa organizzazione. Non sarà disponibile al di fuori di questa organizzazione.

3. Crea o carica un flusso condiviso:
   • Fai clic su Crea per creare un nuovo flusso da zero. Potrai configurare criteri e risorse come passaggi del flusso.

     Viene visualizzata la finestra di dialogo Crea un flusso condiviso.

     1. Inserisci il nome del flusso condiviso.

        Questo sarà il nome che i proxy API e gli altri flussi condivisi utilizzano per fare riferimento a questo flusso condiviso. Il nome deve essere descrittivo per gli sviluppatori che utilizzano il flusso.

     2. Inserisci una descrizione per fornire maggiori informazioni sulle funzioni del flusso.
     3. Se la tua organizzazione ha attivato Apigee Spaces, puoi associare il flusso condiviso a uno spazio selezionato dall'elenco delle opzioni disponibili. Per saperne di più, consulta la panoramica di Apigee Spaces.
     4. Fai clic su Crea.

        Il flusso condiviso viene creato.

     5. Successivamente, puoi sviluppare le funzionalità del flusso condiviso ed eseguirne il deployment nell'ambiente desiderato.
   • Fai clic su Carica bundle per creare un flusso condiviso da origini esistenti caricando un bundle di flussi.

     Un bundle di flussi condivisi contiene gli artefatti di origine di un flusso condiviso. Ad esempio, se scarichi un flusso condiviso dalla console Apigee, avrai un file zip con il bundle del flusso.

     Viene visualizzata la finestra di dialogo Crea un flusso condiviso.

     1. Seleziona il file zip contenente gli artefatti che vuoi nel nuovo flusso.
     2. Fai clic su Apri.
     3. Inserisci un nome per il flusso condiviso importato.

        Questo sarà il nome che i proxy API e gli altri flussi condivisi utilizzano per fare riferimento a questo flusso condiviso. Il nome deve essere descrittivo per gli sviluppatori che utilizzano il flusso.

     4. Fai clic su Crea.

        Il flusso condiviso viene creato dal bundle.

     5. Successivamente, puoi sviluppare le funzionalità del flusso condiviso ed eseguirne il deployment nell'ambiente desiderato.

Apigee classico

1. Accedi alla UI Apigee.
2. Seleziona l'organizzazione che contiene il flusso condiviso. Vedi Passare da un'organizzazione all'altra.

   Il flusso condiviso sarà disponibile per tutti i proxy API e i flussi condivisi di cui è stato eseguito il deployment in un ambiente di questa organizzazione. Non sarà disponibile al di fuori di questa organizzazione.

3. Seleziona Sviluppa > Flussi condivisi nella barra di navigazione a sinistra.
4. Crea o carica un flusso condiviso:
   • Fai clic su Crea nuovo per creare un nuovo flusso da zero. Potrai configurare criteri e risorse come passaggi del flusso.

     Viene visualizzata la finestra di dialogo Crea un flusso condiviso.

     1. Inserisci il nome del flusso condiviso.

        Questo sarà il nome che i proxy API e gli altri flussi condivisi utilizzano per fare riferimento a questo flusso condiviso. Il nome deve essere descrittivo per gli sviluppatori che utilizzano il flusso.

     2. Inserisci una descrizione per fornire maggiori informazioni sulle funzioni del flusso.
     3. Se la tua organizzazione ha attivato Apigee Spaces, puoi associare il flusso condiviso a uno spazio selezionato dall'elenco delle opzioni disponibili. Per saperne di più, consulta la panoramica di Apigee Spaces.
     4. Fai clic su Crea.

        Il flusso condiviso viene creato.

     5. Successivamente, puoi sviluppare le funzionalità del flusso condiviso ed eseguirne il deployment nell'ambiente desiderato.
   • Fai clic su Carica bundle per creare un flusso condiviso da origini esistenti caricando un bundle di flussi.

     Un bundle di flussi condivisi contiene gli artefatti di origine di un flusso condiviso. Ad esempio, se scarichi un flusso condiviso dalla UI di Apigee, avrai un file zip con il bundle del flusso.

     Viene visualizzata la finestra di dialogo Crea un flusso condiviso.

     1. Seleziona il file zip contenente gli artefatti che vuoi nel nuovo flusso.
     2. Fai clic su Apri.
     3. Inserisci un nome per il flusso condiviso importato.

        Questo sarà il nome che i proxy API e gli altri flussi condivisi utilizzano per fare riferimento a questo flusso condiviso. Il nome deve essere descrittivo per gli sviluppatori che utilizzano il flusso.

     4. Fai clic su Crea.

        Il flusso condiviso viene creato dal bundle.

     5. Successivamente, puoi sviluppare le funzionalità del flusso condiviso ed eseguirne il deployment nell'ambiente desiderato.

Chiamata di un flusso condiviso da un proxy API o da un flusso condiviso

Puoi chiamare un flusso condiviso da un proxy o da un altro flusso condiviso utilizzando il criterio FlowCallout.

Apigee nella console Cloud

1. Esegui una delle seguenti operazioni:

   • Nella console Google Cloud , vai alla pagina Sviluppo proxy > Proxy API.

     Vai ai proxy API

   • Nella console Google Cloud , vai alla pagina Sviluppo proxy > Flussi condivisi.

     Vai a Flussi condivisi

2. Fai clic sulla scheda Sviluppa.
3. Nel riquadro di navigazione, fai clic su accanto a Policy.
4. Nell'elenco delle norme, in Estensione, seleziona FlowCallout.
5. Inserisci il nome visualizzato e il nome (identificatore univoco), poi seleziona il flusso condiviso che verrà chiamato da questo policy.
6. Fai clic su Crea.
7. Fai clic su accanto a Salva e poi su Salva come nuova revisione.

Apigee classico

1. Nell'interfaccia utente Apigee, apri il proxy API o il flusso condiviso da cui vuoi chiamare il flusso condiviso.
2. Fai clic sulla scheda Sviluppa.
3. In Navigatore, accanto a Policy, fai clic su +.
4. Nell'elenco delle norme, nella sezione Estensione, fai clic su FlowCallout.
5. Inserisci il nome visualizzato e il nome (identificatore univoco), poi seleziona il flusso condiviso che verrà chiamato da questo policy.
6. Fai clic su Aggiungi.

Vedi anche

Concatenamento di proxy API