Creazione di flussi condivisi riutilizzabili

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Nota: negli ambienti abilitati per i deployment degli archivi, 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 Sviluppare flussi condivisi utilizzando Apigee in VS Code.

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

Acquisendo in un'unica posizione funzionalità utili in più luoghi, un flusso condiviso ti aiuta a garantire coerenza, ridurre i tempi di sviluppo e gestire più facilmente il codice.

Nota: il seguente video mostra l'editor proxy classico nell'interfaccia utente di Apigee. Apigee sta introducendo una nuova versione dell'Editor proxy, che ha un design diverso dalla versione classica mostrata nel video.

Il seguente video mostra come creare ed eseguire il debug di un flusso condiviso nell'UI di 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 una richiesta di destinazione o dopo un proxy o una risposta di destinazione.

Per riferimento al criterio FlowCallout, consulta le norme relative ai callout Flussi. Per scoprire di più sugli hook di flusso, consulta Collegare un flusso condiviso utilizzando un hook di flusso.

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

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

Nell'illustrazione seguente, due proxy API richiamano (con un criterio FlowCallout) a un flusso condiviso per autenticare le richieste utente in entrata. Il deployment di AuthSharedFlow è stato eseguito 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 di ampi criteri aziendali, quindi utilizzato in proxy da team line-of-business che creano app più specializzate.

Sviluppo di un flusso condiviso

Nota: gestisci gli errori dall'interno del proxy API che chiama il flusso condiviso, anziché all'interno del flusso condiviso stesso. Per maggiori informazioni, consulta Gestione degli errori.

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. Invia invece richieste a un proxy API che, a sua volta, richiama il flusso condiviso.

Ecco i passaggi generali per sviluppare un flusso condiviso:

1. Scopri quale dovrebbe essere l'insieme condiviso di funzionalità.

   Ad esempio, potresti voler combinare funzionalità di gestione del traffico, compresa l'eliminazione dei picchi di traffico. In questo modo, puoi gestire la configurazione al di fuori del flusso di lavoro di chi implementa la logica line-of-business.

2. Sviluppa un flusso condiviso implementando criteri e risorse di supporto, proprio come faresti durante lo sviluppo di un proxy API.

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

   Ad esempio, nell'ambito del supporto della gestione del traffico, potresti implementare un criterio di arresto dei picchi per consentire solo 30 richieste al secondo, come nell'esempio seguente:

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

   Quindi, a un flusso condiviso per la gestione del traffico, puoi collegare il criterio di arresto dei picchi come passaggio. Il criterio viene 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, consulta Creazione di un flusso condiviso nella UI di Apigee.

   Come per i proxy API, puoi importare un file ZIP contenente gli artefatti dell'origine di flusso condivisa 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&sharedFlowID=mySharedFlow" \
     -X POST \
     -F "file=@sharedflow.zip" \
     -H "Authorization: Bearer $TOKEN"
   

   Dove $TOKEN è impostato sul 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 Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le 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. Esegui il deployment di un flusso condiviso nello stesso modo in cui esegui il deployment di un proxy API. Per ulteriori informazioni, consulta Panoramica del deployment.

   Un flusso condiviso deve trovarsi nella stessa organizzazione ed essere sottoposto a deployment nello stesso ambiente dei proxy API e di altri flussi condivisi che ne 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 in Apigee sono deployment senza tempi di inattività.

4. Sviluppa il proxy API di utilizzo 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 hook di flusso.

   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 effettui il callout a un altro servizio, un FlowCallout richiama il flusso condiviso. Il deployment del proxy API di utilizzo deve essere eseguito 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 codice seguente, un criterio FlowCallout chiama un flusso condiviso denominato 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 ulteriori informazioni, consulta Chiamare un flusso condiviso da un proxy API o da un flusso condiviso

5. Esegui il deployment del proxy API che utilizza per iniziare a utilizzare il flusso condiviso. Per ulteriori informazioni sul deployment in generale, consulta Panoramica del deployment.
6. Sviluppa in modo iterativo mediante il tracciamento, come faresti con un proxy API.

   Come con un proxy API, sviluppi un flusso condiviso richiamando e tracciando in modo iterativo fino a ottenere la logica che preferisci. In questo caso, poiché il flusso condiviso non viene eseguito automaticamente, richiami un endpoint proxy ed esegui il debug del proxy.

   Segui questi passaggi:

   1. Assicurati che sia il flusso condiviso sia il proxy API che lo chiama con un criterio FlowCallout si trovino nella stessa organizzazione e che sia stato eseguito il deployment nello stesso ambiente.
   2. Nella scheda Trace del proxy API, inizia a tracciare il proxy API.
   3. Invia una richiesta a un endpoint proxy nel proxy API. Il flusso dall'endpoint deve includere il criterio FlowCallout che richiama il flusso condiviso.
   4. Nella scheda Trace, esamina il flusso dal proxy API a quello condiviso.

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

      

Creazione di un flusso condiviso nella UI di Apigee

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

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

Per creare un flusso condiviso nella UI di Apigee:

1. Accedi all'UI di Apigee.
2. Seleziona l'organizzazione contenente 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 da questa organizzazione. Non sarà disponibile all'esterno di questa organizzazione.

3. Seleziona Sviluppo > 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 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 ulteriori informazioni sulla funzione del flusso.
     3. Fai clic su Crea.

        Il flusso condiviso è stato creato.

     4. In seguito, puoi sviluppare le funzionalità di 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 flusso condiviso contiene gli artefatti di origine di un flusso condiviso. Ad esempio, se scarichi un flusso condiviso dalla UI di Apigee, avresti un file ZIP con il bundle di 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 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. In seguito, puoi sviluppare le funzionalità di flusso condiviso ed eseguirne il deployment nell'ambiente desiderato.

Chiamata a 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.

1. Nella UI di Apigee, apri il proxy API o il flusso condiviso da cui vuoi chiamare il flusso condiviso.
2. Fai clic sulla scheda Sviluppo.
3. Nel Navigatore, accanto a Norme, fai clic su +.
4. Nell'elenco dei criteri, in Estensione, fai clic su FlowCallout.
5. Inserisci il nome e il nome visualizzati (identificatore univoco), poi seleziona il flusso condiviso che verrà chiamato da questo criterio.
6. Fai clic su Aggiungi.
7. Aggiungi il nuovo criterio FlowCallout al proxy dove vuoi che venga effettuata la chiamata.

Vedi anche

Concatenamento tra proxy API