Collegamento e configurazione di criteri nell'interfaccia utente

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

L'aggiunta di funzionalità basate su criteri a un proxy API prevede due passaggi:

1. Configura un'istanza di un tipo di criterio.
2. Collega l'istanza del criterio a un flusso.

Il diagramma seguente mostra la relazione tra criteri e flussi. Come puoi vedere, un criterio è associato a un flusso come "passaggio di elaborazione". Per configurare il comportamento desiderato per la tua API, devi avere qualche conoscenza dei flussi. Questo argomento è stato trattato in precedenza nella sezione Configurare i flussi.

Un tipo di criterio di uso comune è SpikeArrest. SpikeArrest impedisce gli aumenti improvvisi del traffico dei messaggi che potrebbero inondare i servizi di backend.

Collegamento di un criterio a un flusso

Per collegare un criterio a un flusso:

1. Seleziona un proxy API e vai alla vista Sviluppo.
2. Nell'editor del proxy API, seleziona il flusso a cui vuoi collegare un criterio nel riquadro di navigazione.
   Ad esempio, nella figura seguente è selezionato il flusso PreFlow per l'endpoint proxy API predefinito:
   
3. Nella Vista struttura, fai clic su +Passaggio associato al flusso di richiesta o risposta per collegare un criterio. Ad esempio:
   
   Si apre la finestra di dialogo Aggiungi passaggio con un elenco categorizzato di criteri.
   
4. Scorri e seleziona il tipo di criterio che vuoi collegare al flusso selezionato.
5. Modifica i seguenti campi.

   • Nome visualizzato:il nome visualizzato univoco della norma. L'interfaccia utente genererà un nome predefinito, ma è consigliabile creare un nome descrittivo per il criterio. In questo modo, gli altri sviluppatori della tua organizzazione potranno comprendere facilmente l'obiettivo del criterio.

   • Nome: il nome univoco del criterio. Il nome del criterio corrisponde al nome visualizzato, con le seguenti eccezioni:

     • Gli spazi sono sostituiti da trattini.

     • I trattini consecutivi sono sostituiti da un solo trattino.

     • Ad eccezione di trattini, trattini bassi e spazi (che vengono sostituiti, come indicato in precedenza), i caratteri non alfanumerici, ad esempio il cancelletto, i simboli di percentuale, la e commerciale e così via, vengono rimossi.

6. Fai clic su Aggiungi.

   Il criterio è associato al flusso selezionato.

Una volta collegato il criterio, il criterio verrà visualizzato nella visualizzazione Designer del flusso, in questo esempio il PreFlow dell'endpoint proxy predefinito e nell'elenco Criteri nel riquadro di navigazione. La visualizzazione Codice, che mostra il codice XML per il criterio appena associato, viene visualizzata sotto la visualizzazione Designer. Edge genera un'istanza del criterio che contiene un insieme di valori predefiniti ragionevoli.

Aggiunta di un criterio senza collegarlo a un flusso

Per aggiungere un criterio senza associarlo a un flusso, utile per Gestione degli errori, fai clic su + nella barra Norme della visualizzazione Navigazione per aprire la finestra di dialogo Aggiungi criterio e aggiungere il criterio (come descritto nei passaggi da 4 a 6 nella sezione precedente).

Un criterio che non è associato a nessun flusso viene contrassegnato con l'icona "Scollegato" nell'elenco Norme, come mostrato accanto al criterio dei messaggi relativi alle chiavi API mostrato nella figura precedente.

Dopo aver creato la norma, puoi allegarla a un flusso trascinandola dall'elenco Norme al flusso desiderato nella visualizzazione Designer.

Scollegamento dei criteri da un flusso

Per scollegare un criterio da un flusso, seleziona il flusso. Passa il mouse sopra l'icona del criterio nella visualizzazione Designer del flusso. Fai clic sulla X nel cerchio visualizzato nell'icona.

Eliminazione di un'istanza del criterio

Per eliminare un'istanza del criterio, passa il mouse sopra la voce del criterio nella visualizzazione Navigazione. Fai clic sulla X nel cerchio visualizzato a destra della voce.

Configurazione dei criteri nell'interfaccia utente

Quando la UI genera un'istanza del criterio, applica valori predefiniti ragionevoli per le impostazioni comuni. Potrebbe essere necessario modificare queste impostazioni per soddisfare i tuoi requisiti.

Ad esempio:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Puoi configurare un criterio modificando direttamente la sua configurazione XML nella visualizzazione Codice. Ad esempio, la frequenza massima di messaggi per il criterio di arresto anomalo è inizialmente impostata su 30 messaggi al secondo. Puoi modificare la frequenza di picco modificando il valore dell'elemento <Rate> nel file XML del criterio. Per ulteriori dettagli sulla configurazione dei criteri, consulta la documentazione di riferimento alle norme.

Puoi anche tagliare e incollare i criteri nella visualizzazione Codice. Questo è un ottimo modo per riutilizzare i criteri dagli esempi disponibili su GitHub.

Le modifiche apportate a una definizione dei criteri nella vista Codice vengono applicate anche nella finestra Proprietà. È vero anche il contrario: apporta modifiche nel Controllo proprietà e queste vengono visualizzate nel file XML nella vista Codice.

Per la documentazione specifica per i criteri per le quote utilizzati in questo argomento, consulta Criteri per le quote.