Flussi condivisi riutilizzabili

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X.
info

Puoi combinare 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.

Acquisendo in un unico posto funzionalità utili in più punti, 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 nella UI Edge.

Il seguente video di 5 minuti mostra come creare e tracciare un flusso condiviso nella nuova UI Edge (solo Edge for 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 destinazione oppure dopo una risposta proxy o di destinazione.

Per informazioni di riferimento sulla policy FlowCallout, consulta Policy FlowCallout. Per saperne di più sugli hook di flusso, vedi Collegare 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:

  • security, 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.

Sviluppare 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. Invece, invii 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. Quindi, svilupparne uno è come sviluppare un proxy API. Puoi includere le policy e le 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 la policy Spike Arrest 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, vedi Creazione di un flusso condiviso nell'interfaccia utente Edge.

    Come per i proxy API, puoi importare un file ZIP contenente gli artefatti di origine del flusso condiviso (vedi Importare un nuovo proxy API per saperne di più sull'importazione dei proxy). Di seguito viene illustrato come importare un flusso condiviso con l'API Management:

    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 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, vedi Panoramica del deployment.

    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 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 implementato senza tempi di inattività. (Questo è 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 Management:

    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 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 allegare il flusso condiviso al proxy utilizzando un hook di flusso, come descritto in Allegare un flusso condiviso utilizzando un hook di flusso. Per un tutorial introduttivo sulla creazione di un proxy API, consulta Crea 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 Service Callout, 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 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ù, vedi 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ù sull'implementazione in generale, consulta Informazioni sull'implementazione.
  6. Sviluppa in modo iterativo tramite il tracing, come faresti con un proxy API.

    Come per un proxy API, sviluppi un flusso condiviso richiamandolo e tracciandolo in modo iterativo finché non ottieni la logica che desideri. In questo caso, poiché il flusso condiviso non viene eseguito autonomamente, richiami un endpoint proxy e tracci il proxy.

    Procedi nel modo seguente:

    1. 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.
    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 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 FlowCallout precedono i flussi condivisi. Per saperne di più sul tracciamento, vedi Utilizzo dello strumento Trace.

Creare un flusso condiviso nell'interfaccia utente Edge

Quando utilizzi la UI di Apigee Edge per creare un flusso condiviso, puoi crearlo da zero o importando le origini del flusso esistenti come file .zip del bundle di flussi.

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

    1. Accedi a apigee.com/edge.
    2. Seleziona l'organizzazione che contiene 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 Sviluppa > Flussi condivisi nella barra di navigazione a sinistra.

    Nuova UI Edge (Private Cloud)

    Per accedere alla pagina Flussi condivisi utilizzando la nuova UI Edge:

    1. Accedi alla nuova UI Edge all'indirizzo http://host:3001/edge, dove host è l'indirizzo IP o il nome DNS dell'host che esegue la nuova UI Edge.
    2. Seleziona l'organizzazione che contiene 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 Sviluppa > Flussi condivisi nella barra di navigazione a sinistra.
  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 partendo da zero. Potrai configurare le policy e le risorse come passaggi del flusso.
      1. Seleziona Flusso condiviso vuoto.
      2. Inserisci un valore del 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 maggiori informazioni su cosa fa il flusso.
      4. Fai clic su Avanti.
      5. (Facoltativo) 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 Crea e implementa per creare e implementare il nuovo flusso condiviso negli ambienti selezionati. Se non hai selezionato alcun ambiente, il flusso condiviso verrà creato, ma non sottoposto a deployment.

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

        Un bundle di flussi condivisi contiene gli artefatti di origine di un flusso condiviso. Ad esempio, se scarichi un flusso condiviso dall'interfaccia utente 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.

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.

  1. Nell'interfaccia utente di Edge, individua il proxy o il flusso condiviso da cui vuoi chiamare un altro flusso condiviso.
  2. In Navigatore, accanto a Policy, fai clic sul pulsante +.
  3. Nell'elenco dei criteri, fai clic su FlowCallout in Estensione.
  4. Inserisci il nome visualizzato e il nome (identificatore univoco), poi seleziona il flusso condiviso che verrà chiamato da queste norme.
  5. Fai clic su Aggiungi.
  6. Aggiungi il nuovo criterio FlowCallout al proxy da cui vuoi effettuare la chiamata.

Vedi anche

Concatenare i proxy API