Flussi condivisi riutilizzabili

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

Puoi combinare criteri e risorse in un flusso condiviso che puoi utilizzare da più proxy API e persino 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 trovi nella stessa organizzazione del flusso condiviso stesso.

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

Il seguente video mostra come creare e tracciare un flusso condiviso nell'interfaccia utente di Edge.

Il seguente video di 5 minuti mostra come creare e tracciare un flusso condiviso nell'interfaccia utente di Edge classica (solo Edge per Private Cloud).

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 informazioni di riferimento sulle norme relative a FlowCallout, consulta le norme relative a FlowCallout. Per saperne di più sugli hook di flusso, consulta Collegare un flusso condiviso utilizzando un hook di flusso.

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

  • sicurezza, con il codice di autorizzazione che utilizza la verifica OAuth e della chiave API, nonché il 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 eseguono una chiamata (con un criterio FlowCallout) a un flusso condiviso per autenticare le richieste degli utenti in arrivo. AuthSharedFlow è stato disegnato separatamente per l'organizzazione prima dei proxy in modo che sia disponibile per supportare le richieste provenienti dai 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

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

Ecco i passaggi di alto livello per sviluppare un flusso condiviso:

  1. Scopri quale dovrebbe essere l'insieme 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 loro configurazione al di fuori del flusso di lavoro di coloro che implementano la logica di business.

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

    Un flusso condiviso è una sequenza di passaggi condizionali. Sviluppare un'API di questo tipo è quindi come sviluppare un proxy API. Puoi includere criteri e risorse che potresti includere in un proxy.

    Ad esempio, nell'ambito del supporto per la gestione del traffico, potresti implementare un criterio di interruzione per 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>

    Poi, a un flusso condiviso per la gestione del traffico, puoi associare il criterio Arresta picchi come 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, consulta Creare un flusso condiviso nell'interfaccia utente di Edge.

    Come per i proxy API, puoi importare un file ZIP contenente gli elementi dell'origine del flusso condivisi. Per saperne di più sull'importazione dei proxy, consulta Importare un nuovo proxy API. Di seguito viene illustrato come importare un flusso condiviso con l'API di gestione:

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. Esegui il deployment del flusso condiviso nell'ambiente prima di eseguire il deployment di proxy o 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 la Panoramica dell'implementazione.

    Un flusso condiviso deve trovarsi nella stessa organizzazione e essere implementato nello stesso ambiente dei proxy API e di 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 all'API di gestione come la seguente:

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

    Puoi anche sostituire un flusso condiviso attualmente di cui è stato eseguito il deployment senza tempi di inattività. È molto simile ai proxy API. Per saperne di più, consulta Eseguire il deployment dei proxy API utilizzando l'API di gestione. Ecco il modulo di richiesta che utilizza l'API di gestione:

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  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, come descritto in Collegare un flusso condiviso utilizzando un hook di flusso. Per un tutorial introduttivo sulla creazione di un proxy API, consulta Creare il tuo primo proxy API.

    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 il quale chiami un altro servizio, un callout del flusso chiama 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 implementato quando vuoi testare una chiamata utilizzando il criterio FlowCallout.

    Nel codice riportato di seguito, un criterio di FlowCallout richiama 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 saperne di più, consulta Chiamata di un flusso condiviso da un proxy API o da 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 Informazioni sul deployment.
  6. Sviluppa in modo iterativo mediante il tracciamento, come faresti con un proxy API.

    Come per un proxy API, sviluppi un flusso condiviso richiamando e tracciando in modo iterativo fino a quando non hai la logica che vuoi. In questo caso, poiché il flusso condiviso non viene eseguito autonomamente, devi richiamare un endpoint proxy e tracciare il proxy.

    Procedi nel seguente modo:

    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 eseguire il tracciamento del 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 Traccia, esamina il flusso dal proxy API al flusso condiviso.

      Tieni presente che nel monitoraggio, il flusso condiviso è rappresentato come un insieme di passaggi o criteri racchiusi in un riquadro grigio. Le icone che rappresentano i criteri di FlowCallout precedono i flussi condivisi. Per saperne di più sul monitoraggio, consulta Utilizzare lo strumento di monitoraggio.

Creazione di un flusso condiviso nella UI Edge

Quando utilizzi l'interfaccia utente di Apigee Edge per creare un flusso condiviso, puoi crearne uno da zero o importare le origini flusso esistenti come file ZIP del bundle del flusso.

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

    Edge

    Per accedere alla pagina Flussi condivisi utilizzando l'interfaccia utente di Edge:

    1. Accedi ad apigee.com/edge.
    2. Seleziona l'organizzazione contenente il flusso condiviso. Consulta 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.

    Edge classico (private cloud)

    Per accedere alla pagina Flussi condivisi utilizzando l'interfaccia utente classica di Edge:

    1. Accedi a http://ms-ip:9000, dove ms-ip è l'indirizzo IP o il nome DNS del nodo del server di gestione.
    2. Seleziona l'organizzazione contenente il flusso condiviso. Consulta 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 dall'esterno di questa organizzazione.

    3. Seleziona API > Flussi condivisi nella barra di navigazione in alto.
  2. Fai clic sul pulsante + Flusso condiviso per iniziare ad aggiungere un nuovo flusso condiviso.
  3. Nella pagina Crea un flusso condiviso, scegli come creare il nuovo flusso:
    • Crea un nuovo flusso da zero. Potrai configurare criteri e risorse come passaggi del flusso.
      1. Seleziona Svuota flusso condiviso.
      2. Inserisci un valore per il nome. Questo sarà il nome utilizzato dai proxy API e da altri flussi condivisi per fare riferimento a questo flusso condiviso. Il nome deve essere descrittivo per gli sviluppatori che utilizzano il flusso.
      3. Inserisci una descrizione per fornire ulteriori informazioni sulle funzionalità del flusso.
      4. Fai clic su Avanti.
      5. Se vuoi, seleziona gli ambienti in cui vuoi eseguire il deployment del nuovo flusso.

        Ad esempio, se testerai il flusso condiviso dai proxy API di cui è stato eseguito il deployment nell'ambiente di test, esegui il deployment del flusso condiviso in test.

      6. Fai clic su Compila e esegui il deployment per creare e implementare il nuovo flusso condiviso negli ambienti selezionati. Se non hai selezionato nessun ambiente, il flusso condiviso verrà creato, ma non verrà eseguito il deployment.

    • Crea un flusso condiviso da origini esistenti caricando un bundle di flussi.
      1. Seleziona Bundle di flussi condivisi per specificare un file .zip contenente gli elementi che vuoi includere nel nuovo flusso.

        Un bundle di flusso condiviso contiene gli artefatti di origine di un flusso condiviso. Ad esempio, se scarichi un flusso condiviso dall'interfaccia utente di Edge, avrai un file .zip con il bundle del flusso.

      2. Fai clic su Avanti.
      3. Fai clic su Scegli file per cercare il file ZIP contenente le origini del flusso condiviso che vuoi importare.
      4. Nella casella Nome flusso condiviso, inserisci un nome per il flusso importato. Questo sarà il nome utilizzato dai proxy API e da altri flussi condivisi per fare riferimento a questo flusso condiviso. Il nome deve essere descrittivo per gli sviluppatori che utilizzano il flusso.
      5. Fai clic su Avanti.
      6. Fai clic su Crea per creare il nuovo flusso dalle origini che stai importando.

Chiamare 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. Nell'interfaccia utente di Edge, individua il proxy o il flusso condiviso da cui vuoi chiamare un altro flusso condiviso.
  2. Nel Navigatore, accanto a Norme, fai clic sul pulsante +.
  3. Nell'elenco delle norme, fai clic su FlowCallout in Estensione.
  4. Inserisci il nome visualizzato e il nome (identificatore univoco), quindi seleziona il flusso condiviso che verrà chiamato da questo criterio.
  5. Fai clic su Aggiungi.
  6. Aggiungi il nuovo criterio FlowCallout al proxy in cui vuoi che venga effettuata la chiamata.

Vedi anche

Concatenamento di proxy API