Controllo dei proxy API con i flussi

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

I flussi sono i componenti di base di base dei proxy API. I flussi ti consentono di programmare il comportamento di un'API, consentendoti di configurare la sequenza con cui i criteri e il codice vengono eseguiti da un'API proxy.

I flussi sono fasi sequenziali lungo il percorso di elaborazione delle richieste API. Quando aggiungi la logica del proxy, ad esempio per verificare una chiave API, aggiungi la logica come passaggio nella sequenza specificata da un flusso. Quando definisci una condizione per specificare se e quando viene eseguita la logica, la aggiungi al un flusso.

Il seguente esempio di configurazione del flusso definisce un flusso in cui il criterio VerifyAPIKey Viene eseguito se il percorso della richiesta in entrata termina con / e l'HTTP della richiesta verbo è GET.

<Flow name="Get Food Carts">
    <Description>Get Food Carts</Description>
    <Request>
        <Step>
            <Name>Verify-API-Key</Name>
        </Step>
    </Request>
    <Condition>(proxy.pathsuffix MatchesPath "/") and (request.verb = "GET")</Condition>
</Flow>

Viene pubblicato il valore Verify-API-Key nell'elemento <Name> del flusso per includere un criterio configurato altrove nel proxy con XML, come il seguente:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key">
    <DisplayName>Verify API Key</DisplayName>
    <Properties/>
    <APIKey ref="request.header.x-api-key"/>
</VerifyAPIKey>

Progettazione della sequenza di esecuzione del flusso

Strutturare i flussi in modo da poter eseguire la logica nella sequenza corretta lungo di pre-elaborazione.

Nota: consulta Creare il primo proxy API per una semplice tutorial sulla creazione di un flusso. Per le specifiche sulla configurazione dei flussi, consulta Configurazione dei flussi.

Quando decidi dove aggiungere la logica, devi prima scegliere se aggiungerla a un endpoint proxy o endpoint di destinazione. Un proxy API divide il suo codice tra codice che interagisce con il proxy (endpoint proxy) e codice facoltativo che interagisce con l'eventuale target del backend del proxy (endpoint di destinazione).

Entrambi gli endpoint contengono flussi, come descritto qui:

Tipo di endpoint	Descrizione	Flussi supportati
ProxyEndpoint	Contiene i flussi proxy API più vicini al client. Fornisce luoghi in cui la logica può agire prima sulla richiesta del client e poi sulla risposta al client.	PreFlow, flussi condizionali, PostFlow, PostClientFlow
TargetEndpoint	Contiene i flussi del proxy API più vicini alla risorsa di backend. Fornisce punti per la logica preparare una richiesta e gestirne la risposta da una risorsa di backend.	PreFlow, flussi condizionali, PostFlow

Configuri il flusso con un file XML che specifica cosa deve accadere e in quale ordine. Le seguenti illustrazione mostra come i flussi vengono ordinati in sequenza all'interno di un endpoint proxy e di una destinazione endpoint:

L'endpoint proxy e l'endpoint di destinazione contengono ciascuno flussi che puoi organizzare nel sequenza precedente:

Posizione	Tipo di flusso	Descrizione
1	PreFlow	Utile quando devi assicurarti che un determinato codice venga eseguito prima di qualsiasi altra . Se PreFlow si trova in un endpoint di destinazione, viene eseguito dopo PostFlow.
2	Flusso condizionale	Il posto per la logica condizionale. Viene eseguita dopo il PreFlow e prima del PostFlow. Viene eseguito un solo flusso condizionale per segmento: il primo flusso la cui condizione restituisce true. Ciò significa che puoi eseguire un flusso condizionale come parte ciascuno dei seguenti: Pipeline di richieste di ProxyEndpoint Pipeline di richieste di TargetEndpoint Pipeline di risposta di ProxyEndpoint Pipeline di risposta di TargetEndpoint
3	PostFlow	È un buon posto per registrare i dati e inviare una notifica per informare che si è verificato un problema mentre l'elaborazione della richiesta e così via. Viene eseguita dopo i flussi condizionali e PreFlow. Se PostFlow si trova in un endpoint proxy ed è presente un endpoint di destinazione, L'endpoint PostFlow viene eseguito prima dell'endpoint di destinazione PreFlow.
4	PostClientFlow (solo flusso proxy)	Flusso per il logging dei messaggi dopo che una risposta viene restituita al client.

Eseguire il codice con un comando PreFlow

Un PreFlow è utile quando devi assicurarti che un determinato codice venga eseguito prima di qualsiasi altra .

In un endpoint proxy, PreFlow è un ottimo posto per il codice che autentica un client limita il traffico dai client. In un endpoint di destinazione, dove inizia a prepararsi per inviare una richiesta un target di backend, un PreFlow è ideale per i primi passi nella preparazione all'invio della richiesta.

Ad esempio, in genere non è consigliabile fornire assistenza a un client che ha superato la quota disponibile. A che supportano questi requisiti, inserisci i criteri di sicurezza e quota nel segmento PreFlow. In questo modo non devi preoccuparti se una condizione non viene valutata in un flusso condizionale successivo. La i criteri in questo flusso verranno sempre eseguiti prima di qualsiasi altra elaborazione.

Nell'esempio seguente, i criteri SpikeArrest e Quota vengono eseguiti prima che l'elaborazione passi a condizionali.

<PreFlow name="MyPreFlow">
    <Request>
        <Step>
            <Name>Spike-Arrest</Name>
        </Step>
        <Step>
            <Name>Quota</Name>
        </Step>
    </Request>
    <Response/>
</PreFlow>

Avere il codice viene eseguito in modo condizionale con un flusso condizionale

Tra un PreFlow e un PostFlow, puoi avere flussi che vengono eseguiti in modo condizionale. Ciò consente di puoi configurare più sequenze di logica, ma eseguirne una sola in base lo stato del proxy. Un flusso condizionale è facoltativo se puoi eseguire tutta la logica in PreFlow PostFlow e non sono richieste condizioni (in altre parole, solo un percorso attraverso l'endpoint è supportato).

Ogni flusso specifica una condizione che verifica i diversi valori di stato. In questo modo, dirama l'esecuzione in base alle condizioni. Ad esempio, potresti voler convertire solo da XML a JSON quando l'app richiedente è in esecuzione su un dispositivo mobile.

Nota: in un flusso condizionale, la condizione viene valutata sia nella classe richiesta e risposta. Non puoi avere condizioni distinte per la richiesta e la risposta. Solo uno viene eseguito un flusso condizionale, ovvero il primo flusso la cui condizione restituisce true.

In questo caso, i vincoli di quota vengono applicati solo se la richiesta è una richiesta GET con un Pattern URI di /issue/** (/issue/ con qualsiasi elemento nell'URI dopo l'ultimo inoltro barra).

<Flow name="MyFlow">
    <Description/>
    <Request>
        <Step>
            <Name>Quota</Name>
        </Step>
    </Request>
    <Response/>
    <Condition>(proxy.pathsuffix MatchesPath "/issue/**") and (request.verb = "GET")</Condition>
</Flow>

Puoi usare le variabili di flusso per specificare le condizioni. Per ulteriori informazioni sull'uso delle variabili nelle condizioni, consulta Condizioni con variabili di flusso.

Per esempi di utilizzo della corrispondenza di pattern nelle condizioni, consulta Corrispondenza di pattern.

Possedere codice da eseguire dopo la logica principale con un PostFlow

Un PostFlow è un ottimo posto per eseguire azioni dopo la logica principale dell'endpoint e prima l'elaborazione dell'endpoint. Un PostFlow viene eseguito dopo i flussi condizionali e PreFlow.

PostFlow è un ottimo posto per registrare alcuni dati, inviare una notifica per informarsi trasformare il formato del messaggio di risposta e così via.

Nell'esempio seguente, un criterioAssignMessage chiamato SetResponseHeaders imposta le intestazioni di il messaggio di risposta prima che Apigee invii la risposta al client.

<PostFlow>
    <Response>
        <Step>
            <Name>SetResponseHeaders</Name>
        </Step>
    </Response>
 </PostFlow>

Fare in modo che il codice venga eseguito dopo che il client ha ricevuto la risposta del proxy con un PostClientFlow.

Un PostClientFlow può includere solo i seguenti criteri. Non è possibile utilizzare altri criteri in un PostClientFlow:

• Norme sui callout di flusso^*
• Criterio MessageLogging
• Norme relative a ServiceCallout

^* Il criterio FlowCallout può chiamare solo i flussi condivisi che a loro volta soddisfano le criteri per la presenza in PostClientFlow (ovvero, contengono solo criteri compatibili).

Se ne includi uno, un PostClientFlow sarà l'ultimo flusso da eseguire, che viene eseguito dopo l'invio di una risposta all'oggetto di alto profilo.

Un PostClientFlow è ideale per il logging finale. Inoltre, puoi registrare i timestamp di inizio e di fine del messaggio di risposta.

Ecco un esempio di PostClientFlow con un criterio MessageLogging collegato.

  <ProxyEndpoint name="endpoint1">
    ...
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
    <PostClientFlow>
        <Response>
            <Step>
                <Name>Message-Logging-1</Name>
            </Step>
        </Response>
    </PostClientFlow>
    ...
  </ProxyEndpoint>

Per ulteriori informazioni, consulta Riferimento alla configurazione del proxy API.

Aggiunta della logica ai flussi

Quando aggiungi logica al proxy, puoi farlo aggiungendo criteri ai flussi del proxy. Esattamente come vengono eseguiti in sequenza (PreFlow, Flow, PostFlow, come descritto in questo argomento), i contenuti di un flusso vengono eseguiti in sequenza.

Nota: per ulteriori informazioni sulle norme, incluso come aggiungerle al nella console Google Cloud e nel codice, Che cos'è una norma? Per maggiori dettagli sul collegamento dei criteri ai flussi, consulta Flussi condizionali.

La configurazione del flusso di esempio seguente fa riferimento a tre criteri (configurati altrove in propri file XML). Il criterio a cui fa riferimento Verify-API-Key viene eseguito prima di norma a cui si fa riferimento in Assign-Message; entrambi sono seguiti dal criterio rappresentato da Quota.

<Flow name="Get Food Cart Menus">
  <Description>Get Food Cart Menus</Description>
  <Request>
    <Step>
      <Name>Verify-API-Key</Name>
    </Step>
    <Step>
      <Name>Assign-Message</Name>
    </Step>
    <Step>
      <Name>Quota</Name>
    </Step>
  </Request>
  <Condition>(proxy.pathsuffix MatchesPath "/") and (request.verb = "GET")</Condition>
</Flow>

Nota: nel codice riportato sopra la condizione del percorso, (proxy.pathsuffix MatchesPath "/") è sempre vero perché "/" è sempre corrispondente. Puoi semplicemente rimuoverla dall'elemento Condition e utilizzare il verbo condizione:

    <Condition>request.verb = "GET"</Condition>

Flussi di debug

Lo strumento di debug fornisce un modo grafico per vedere in che modo la logica nel proxy API è disponibile. viene eseguita a seguito di una richiesta. Lo strumento illustra l'elaborazione tra richiesta e risposta. it non illustra in modo specifico la separazione tra PreFlow, i flussi condizionali e PostFlow.

Per scoprire di più sui proxy di debug, vedi Utilizzo dello strumento di debug.

Gestione degli errori nei flussi

Puoi generare gli errori da varie posizioni in un proxy API, inclusi i flussi.

L'esempio seguente è la stanza di risposta da un PreFlow in un endpoint di destinazione, in altri parole, è il codice che viene eseguito subito dopo aver ricevuto la risposta dalla destinazione di un backend. Nell'esempio, viene generato un errore se la risposta dal target non è 200 (riuscito).

<PreFlow name="PreFlow">
    <Response>
        <Step>
            <Name>RaiseFault</Name>
            <Condition>(response.status.code GreaterThan "200")</Condition>
        </Step>
    </Response>
</PreFlow>

Per saperne di più sulla gestione degli errori, consulta Gestione degli errori.