Collegamento di un flusso condiviso utilizzando un hook di flusso

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Puoi fare in modo che i flussi condivisi eseguano la pre-elaborazione delle richieste standard o la post-elaborazione delle risposte in un insieme di API. Con un hook di flusso, colleghi un flusso condiviso in modo che venga eseguito nello stesso punto per tutti i proxy API di cui è stato eseguito il deployment in un ambiente specifico. In questo modo ottieni una sequenza di logica implementata e distribuita separatamente che non fa parte del codice di implementazione di un proxy.

Poiché il codice collegato a un hook di flusso si trova al di fuori del contesto della logica principale del proxy API, alcuni dei suoi comportamenti differiscono da quelli dei 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 collegato a un hook del flusso genera un errore o si verificano errori durante l'esecuzione del flusso condiviso, il messaggio verrà rifiutato e l'errore verrà restituito al chiamante.
  • Se un messaggio viene rifiutato durante l'esecuzione di un hook di 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 un messaggio di errore

Il seguente video mostra come collegare un flusso condiviso a un hook di flusso, quindi tracciarlo, nella UI di Apigee.

Un flusso condiviso collegato a un proxy tramite un hook di flusso è un ottimo posto per la logica che applica requisiti di policy generali. Ad esempio, supponiamo che un team gestisca un singolo insieme di requisiti di sicurezza per più team che rappresentano diverse linee di business (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 questi requisiti di sicurezza in un flusso condiviso, quindi collegare il flusso all'ambiente Apigee utilizzando un hook di flusso. Poiché il flusso condiviso non fa parte del codice proxy, il team di sicurezza può rivederlo in base alle esigenze 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 nell'ambiente dell'hook del proxy. Per questo motivo, la possibilità di utilizzare gli hook di flusso è disponibile solo per gli amministratori di un'organizzazione Apigee.

Per saperne di più sui flussi condivisi, vedi Creazione di flussi condivisi riutilizzabili.

Colleghi un flusso condiviso a un hook di flusso utilizzando la UI Apigee o l'API Flowhooks. Puoi collegare al massimo un flusso condiviso a un hook di flusso in ciascuna delle seguenti posizioni:

  • Hook del flusso pre-proxy per la logica da applicare PRIMA dell'esecuzione di un endpoint proxy.

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

  • Hook del flusso pre-target per la logica da applicare PRIMA dell'esecuzione di un endpoint di destinazione.

    Ad esempio, potresti implementare la registrazione prima che la richiesta raggiunga il backend. Puoi anche imporre la mediazione rimuovendo determinati campi dalla richiesta.

  • Hook del flusso post-target per la logica da applicare DOPO l'esecuzione della risposta target.

    Questa operazione verrà applicata subito dopo la risposta del backend. Puoi utilizzarlo per registrare la risposta del backend o eseguire una mediazione rimuovendo i campi sensibili dalla risposta del backend.

  • Hook del flusso post-proxy per la logica da applicare DOPO l'endpoint proxy e subito prima che la risposta venga inviata al client.

    Ciò potrebbe includere una logica di applicazione per CORS, la registrazione della risposta o l'esecuzione di alcuni mashup o formattazioni.

Collegamento di un flusso condiviso a un hook di flusso

Per collegare un flusso condiviso a un hook del flusso, devi essere un amministratore dell'organizzazione che contiene il flusso condiviso.

Apigee nella console Cloud

Per collegare un flusso condiviso a un hook di flusso:

  1. Nella console Google Cloud , vai alla pagina Gestione > Ambienti.

    Vai ad Ambienti

  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 dall'esterno dell'organizzazione.

  3. Seleziona l'ambiente che vuoi modificare dall'elenco degli ambienti disponibili.
  4. Fai clic sulla scheda Hook di flusso nella pagina Dettagli ambiente.

    Viene visualizzata la visualizzazione Hook di flusso.

  5. Nell'elenco degli hook di flusso, identifica l'hook di flusso a cui vuoi collegare il flusso condiviso. L'hook del flusso che scegli dipende da dove vuoi che venga eseguito il flusso condiviso.
    Posizione dell'hook del flusso Descrizione
    Pre-proxy Esegue before un endpoint proxy
    Pre-target Viene eseguito prima dell'esecuzione di un endpoint di destinazione
    Post-target Esegue after dopo l'esecuzione della risposta di destinazione
    Post-proxy Viene eseguito dopo l'endpoint proxy e subito prima che la risposta venga inviata al client
  6. Nella casella di elenco dell'hook del flusso che hai scelto, seleziona il flusso condiviso da collegare.
  7. Collega i flussi condivisi ad altri hook di flusso in base alle necessità.
  8. Fai clic su Salva per collegare i flussi condivisi selezionati agli hook di flusso.

Apigee classico

Per collegare un flusso condiviso a un hook di flusso:

  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 dall'esterno dell'organizzazione.

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

    La visualizzazione Hook di flusso mostra:

    Pagina degli hook di flusso che mostra
    i flussi condivisi Pre-proxy, Pre-target, Post-proxy e Post-target

  4. Nell'elenco a discesa dell'ambiente, seleziona quello che vuoi modificare.
  5. Nell'elenco degli hook di flusso, identifica l'hook di flusso a cui vuoi collegare il flusso condiviso. L'hook del flusso che scegli dipende da dove vuoi che venga eseguito il flusso condiviso.
    Posizione dell'hook del flusso Descrizione
    Pre-proxy Esegue before un endpoint proxy
    Pre-target Viene eseguito prima dell'esecuzione di un endpoint di destinazione
    Post-proxy Viene eseguito dopo l'endpoint proxy e subito prima che la risposta venga inviata al client
    Post-target Esegue after dopo l'esecuzione della risposta di destinazione
  6. Posiziona il cursore sul punto di aggancio 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 allegare nel menu Flusso condiviso.
  9. Fai clic su OK.
  10. Collega i flussi condivisi ad altri hook di flusso in base alle necessità.