Collegamento e configurazione di criteri nell'interfaccia utente

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

L'aggiunta di funzionalità basate su policy a un proxy API è una procedura composta da due passaggi:

  1. Configura un'istanza di un tipo di policy.
  2. Collega l'istanza della policy a Flow.

Il diagramma seguente mostra la relazione tra le policy e i flussi. Come puoi vedere, una policy è associata a un flusso come "passaggio" di elaborazione. Per configurare il comportamento desiderato per la tua API, devi conoscere un po' i flussi. Questo argomento è stato trattato in precedenza nella sezione Configurazione dei flussi.

Relazione tra policy e flussi

Un tipo di policy di uso comune è SpikeArrest. SpikeArrest impedisce aumenti improvvisi del traffico di messaggi che potrebbero sovraccaricare i servizi di backend.

Collegamento di una policy a un flusso

Per collegare una policy a un flusso:

  1. Seleziona un proxy API e vai alla visualizzazione Sviluppa.
  2. Nell'editor del proxy API, seleziona il flusso a cui vuoi collegare una policy nel riquadro Navigatore.
    Ad esempio, nella figura seguente è selezionato il flusso PreFlow per l'endpoint del proxy API predefinito:
    Seleziona il flusso a cui vuoi allegare le norme
  3. Nella visualizzazione Progettazione, fai clic su +Passaggio associato al flusso di richiesta o risposta per collegare una policy. Ad esempio:
    Fai clic su +Passaggio.
    Viene visualizzata la finestra di dialogo Aggiungi passaggio con un elenco di policy suddivise per categorie.
    Elenco delle norme per categorie
  4. Scorri e seleziona il tipo di policy che vuoi collegare al flusso selezionato.
  5. Modifica i seguenti campi.
    • Nome visualizzato:nome visualizzato univoco per la policy. L'interfaccia utente genererà un nome predefinito, ma ti consigliamo di creare un nome descrittivo per la policy. In questo modo, gli altri sviluppatori della tua organizzazione potranno capire facilmente lo scopo della policy.

    • Nome: nome univoco per la policy. Il nome della policy corrisponde al nome visualizzato con le seguenti eccezioni:

      • Gli spazi vengono sostituiti da trattini.

      • I trattini consecutivi vengono sostituiti da un singolo trattino.

      • Ad eccezione di trattini, trattini bassi e spazi (che vengono sostituiti, come indicato sopra), i caratteri non alfanumerici, come simboli di sterlina, simboli di percentuale, e commerciali, e così via, vengono rimossi.

  6. Fai clic su Aggiungi.

    La policy è collegata al flusso selezionato.

Dopo aver collegato la policy, la vedrai visualizzata nella visualizzazione Progettazione per il flusso, in questo esempio il PreFlow dell'endpoint del proxy predefinito, e nell'elenco Policy nel riquadro di navigazione. La visualizzazione Codice, che mostra il codice XML della policy appena collegata, viene visualizzata sotto la visualizzazione Progettazione. Edge genera un'istanza della policy che contiene un insieme di valori predefiniti ragionevoli.

Norme nel pre-flow in Designer e Vista codice

Aggiunta di una policy senza collegarla a un flusso

Per aggiungere una policy senza collegarla a un flusso, utile per la gestione degli errori, fai clic su + nella barra Policy nella visualizzazione Navigatore per aprire la finestra di dialogo Aggiungi policy e aggiungi la policy (come descritto nei passaggi da 4 a 6 della sezione precedente).

Fai clic su + per aggiungere la policy.

Una policy non collegata a nessun flusso è contrassegnata con l'icona "scollegata" nell'elenco Policy, come mostrato accanto alla policy del messaggio della chiave API nella figura precedente.

Dopo aver creato la policy, puoi collegarla a un flusso trascinandola dall'elenco Policy al flusso desiderato nella visualizzazione Progettazione.

Scollegamento delle policy da un flusso

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

Eliminazione di un'istanza della policy

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

Configurazione delle policy nell'interfaccia utente

Quando l'interfaccia utente genera un'istanza della policy, applica valori predefiniti ragionevoli per le impostazioni comuni. Potresti dover 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 una policy modificando direttamente la relativa configurazione XML nella Codice visualizzazione. Ad esempio, la velocità di messaggi di picco per la policy Spike Arrest è inizialmente impostata su 30 messaggi al secondo. Puoi modificare la velocità di picco modificando il valore dell'elemento <Rate> nel file XML per la policy. Per ulteriori dettagli sulla configurazione delle policy, consulta il riferimento alle policy.

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

Quando apporti modifiche a una definizione di policy nella visualizzazione Codice, le modifiche vengono riflesse in Property Inspector. Vale anche il contrario: se apporti modifiche su Property Inspector, queste vengono visualizzate nell'XML nella visualizzazione Codice.

Per la documentazione specifica delle policy relative alle quote utilizzate in questo argomento, consulta Policy relative alle quote.