Collegamento e configurazione di criteri nei file XML

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

Puoi creare e modificare i criteri in locale utilizzando il tuo editor o IDE di testo o XML preferito. Questo argomento utilizza il tipo di criterio per le quote come esempio di come creare, configurare, collegare, eseguire il deployment e testare i criteri.

La maggior parte dei proxy API applica una quota. Le quote consentono di controllare la frequenza con cui un'app client può richiamare un'API in un determinato intervallo di tempo. Nell'esempio seguente, un criterio per le quote è configurato per limitare le app a una richiesta al minuto. Anche se questo potrebbe non essere realistico, fornisce un modo semplice per vedere gli effetti di una norma.

In una configurazione del proxy API, i file dei criteri sono archiviati come file XML nella directory /apiproxy/policies.

Ad esempio, un criterio di tipo Quota denominato "QuotaPolicy" potrebbe essere creato come file denominato QuotaPolicy.xml con i seguenti contenuti:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Puoi creare un file di testo manualmente oppure generare il criterio da uno schema XML. Tutti i criteri hanno alcune impostazioni specifiche per il tipo di criterio, mentre altre sono generiche per tutti i criteri.

Quando colleghi i criteri nell'interfaccia utente di gestione, il generatore di proxy API genera l'istanza del criterio dallo schema XML per il tipo di criterio selezionato. Pertanto, nella configurazione dei criteri potresti notare elementi che, per chiarezza, non sono sempre inclusi nella documentazione.

Tutti i criteri definiscono i seguenti attributi:

  • enabled: indica se il criterio è "attivato" o "disattivato". È possibile attivare/disattivare i criteri in fase di runtime modificando questa impostazione. Un criterio con enabled impostato su false non viene applicato in modo forzato.
  • continueOnError: definisce se la pipeline deve continuare a elaborare il messaggio in caso di errore del criterio. Quando applichi criteri per le quote, è probabile che gli errori indichino che la quota è stata superata e, pertanto, questo attributo deve essere impostato su false.
  • name: il nome che assegni a questo criterio. Il nome è univoco per questa istanza del criterio e viene utilizzato per collegare il criterio al flusso come passaggio di elaborazione.

Nell'esempio precedente, gli elementi Allow, Interval e TimeUnit sono specifici del criterio per le quote. Questi elementi forniscono le impostazioni che i servizi API applicano per conto di un'API. Altri tipi di criteri definiscono le proprie impostazioni. Puoi trovare ulteriori informazioni nella documentazione di riferimento alle norme.