Collegamento di un flusso condiviso utilizzando un hook di flusso

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Puoi fare in modo che i flussi condivisi eseguano la preelaborazione delle richieste o il post-trattamento delle risposte di boilerplate in un insieme di API. Con un hook di flusso, colleghi un flusso condiviso in modo che viene eseguito nella stessa posizione per tutti i proxy API di cui è stato eseguito il deployment in un ambiente specifico. Ciò consente di una sequenza di logica implementata e sottoposta a deployment separatamente che non fa parte del server di implementazione del codice.

Poiché il codice collegato a un hook di flusso non rientra nel contesto della logica principale del proxy API, alcune del suo comportamento differisce dai proxy API. Tieni presente che:

  • Devi disporre dell'autorizzazione per collegare un flusso condiviso a un hook di flusso. Devi essere un amministratore dell'organizzazione.
  • Puoi collegare un solo flusso condiviso a ogni hook di flusso.
  • Puoi collegare lo stesso flusso condiviso a più hook di flusso.
  • Se un flusso condiviso associato a un hook di flusso genera un errore o si verificano errori durante dell'esecuzione del flusso, il messaggio verrà rifiutato e l'errore verrà inviato al chiamante.
  • Se un messaggio viene rifiutato durante l'esecuzione di un hook del flusso, i dettagli verranno registrati in Analytics nel contesto del proxy chiamato. Il flusso condiviso può anche generare un errore con un codice personalizzato e messaggio di errore

Il seguente video mostra come collegare un flusso condiviso a un hook del flusso e poi tracciarlo nell'interfaccia utente di Apigee.

Un flusso condiviso collegato a un proxy tramite un hook di flusso è un ottimo posto per la logica che impone requisiti di criteri generali. Ad esempio, immagina di avere un team che gestisce insieme di requisiti di sicurezza per più team che rappresentano diversi settori di attività (LOB). Ogni team LOB può sviluppare API in base ai propri requisiti e senza dover tenere conto dei requisiti di sicurezza più ampi. Il team di sicurezza può implementare tali misure i requisiti in un flusso condiviso, quindi collegalo all'ambiente Apigee utilizzando hook. Poiché il flusso condiviso non fa parte del codice proxy, il team per la sicurezza può modificarlo in base alle necessità senza interferire con il codice LOB.

I flussi condivisi collegati tramite hook di flusso vengono eseguiti in quella posizione per ogni proxy API di cui è stato eseguito il deployment all'ambiente dell'hook del proxy. Per questo motivo, la possibilità di utilizzare gli hook dei flussi è disponibile solo per gli amministratori di un'organizzazione Apigee.

Per saperne di più sui flussi condivisi, consulta Creare flussi condivisi riutilizzabili.

Puoi collegare un flusso condiviso a un hook di flusso utilizzando l'UI di Apigee o l'API Dataflow. Puoi collega al massimo un flusso condiviso a un hook di flusso in ognuna delle seguenti posizioni:

  • Hook pre-proxy del flusso per la logica che deve essere applicata PRIMA di un endpoint proxy .

    Ad esempio, potresti avere una logica per applicare la sicurezza a tutte le API in un ambiente.

  • Hook di flusso pre-target per la logica che deve essere applicata PRIMA di un endpoint di destinazione .

    Ad esempio, puoi implementare il logging prima che la richiesta raggiunga il backend. Puoi anche impostare la mediazione rimuovendo determinati campi dalla richiesta.

  • Hook del flusso post-target per la logica che deve essere applicata DOPO l'esecuzione della risposta target.

    L'applicazione verrà applicata subito dopo che la risposta arriverà dal backend. Puoi utilizzarlo per registrare la risposta del backend o eseguire una mediazione rimuovendo i campi sensibili dalla risposta del backend.

  • Hook post-proxy del flusso per la logica che deve essere applicata DOPO l'endpoint proxy e subito prima che la risposta venga inviata al cliente.

    Ciò potrebbe includere una logica di applicazione per CORS, il logging della risposta o l'esecuzione un mashup o una formattazione.

Collegamento di un flusso condiviso a un hook di flusso

Per collegare un flusso condiviso a un hook di flusso, devi essere un amministratore dell'organizzazione contenente il flusso condiviso.

Apigee nella console Cloud

Per collegare un flusso condiviso a un hook di flusso:

  1. Apri la UI di Apigee nella console Cloud in un browser.
  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 di un ambiente di lavoro di questa organizzazione. Non sarà disponibile al di fuori di questa organizzazione.

  3. Nel riquadro di navigazione a sinistra, fai clic su Gestione > Ambienti.
  4. Seleziona l'ambiente che vuoi modificare dall'elenco degli ambienti disponibili.
  5. Fai clic sulla scheda Ami di flusso nella pagina Dettagli ambiente.

    Viene visualizzata la visualizzazione Hook di flusso.

  6. Nell'elenco degli hook di flusso, identifica l'hook di flusso a cui vuoi collegare il flusso condiviso. L'hook di flusso scelto dipende da dove vuoi che venga eseguito il flusso condiviso.
    Posizione hook di flusso Descrizione
    Pre-proxy Viene eseguito prima di eseguire un endpoint proxy
    Pre-target Viene eseguita prima dell'esecuzione di un endpoint target
    Post-target Viene eseguito dopo l'esecuzione della risposta target
    Post-proxy Viene eseguito dopo l'endpoint proxy e subito prima che la risposta venga inviata al client.
  7. Nella casella dell'elenco dell'aggancio del flusso che hai scelto, seleziona il flusso condiviso da allegare.
  8. Collega i flussi condivisi ad altri hook di flusso, se necessario.
  9. Fai clic su Salva per collegare i flussi condivisi selezionati agli hook di flusso.

Apigee classica

Per collegare un flusso condiviso a un hook di flusso:

  1. Accedi alla UI di Apigee.
  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 dall'esterno di questa organizzazione.

  3. Seleziona Amministratore > Ambienti > Hook di flusso nella barra di navigazione a sinistra.

    Viene visualizzata la vista Ami di flusso:

    Pagina Hook di flusso che mostra
    Flussi condivisi pre-proxy, pre-target, post-proxy e post-target

  4. Nell'elenco a discesa dell'ambiente, seleziona l'ambiente da modificare.
  5. Nell'elenco degli hook di flusso, identifica l'hook di flusso a cui vuoi collegare il flusso condiviso. Il flusso di hook scelto dipende da dove vuoi che venga eseguito il flusso condiviso.
    Posizione hook di flusso Descrizione
    Pre-proxy Viene eseguito prima di eseguire un endpoint proxy
    Pre-target Viene eseguita prima dell'esecuzione di un endpoint target
    Post-proxy Esegui dopo l'endpoint del proxy e subito prima che la risposta venga inviata al cliente
    Dopo il target Viene eseguito dopo l'esecuzione della risposta target
  6. Posiziona il cursore sopra il collegamento del flusso nell'elenco per visualizzare la colonna delle azioni.
  7. Fai clic su Modifica.
  8. Nella finestra di dialogo Flusso condiviso, seleziona il flusso condiviso che vuoi collegare nella Menu Flusso condiviso.
  9. Fai clic su OK.
  10. Collega i flussi condivisi ad altri hook di flusso, se necessario.