Che cos'è un criterio?

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Apigee ti consente di programmare il comportamento delle API senza scrivere codice, tramite i criteri. Un criterio è come un modulo che implementa una funzione di gestione limitata specifica. I criteri sono progettati per consentirti di aggiungere tipi comuni di funzionalità di gestione a un'API in modo semplice e affidabile. I criteri offrono funzionalità come sicurezza, limitazione di frequenza, trasformazione e mediazione, in modo da non dover programmare e gestire in autonomia questa funzionalità.

Non hai limitazioni all'insieme di tipi di criteri forniti da Apigee. Puoi anche scrivere script e codice personalizzati (come applicazioni JavaScript), che estendono la funzionalità proxy API e ti consentono di innovare oltre alle funzionalità di gestione di base supportate dai criteri di Apigee.

Guarda questo video per un'introduzione alla presentazione delle norme e alla loro applicazione.

Tipi di criteri

Tecnicamente, un criterio è un file di configurazione in formato XML. La struttura di ogni tipo di criterio (ad esempio, gli elementi di configurazione obbligatori e facoltativi) è definita da uno schema XML. Se hai familiarità con gli strumenti XML, vale la pena acquisire familiarità con gli schemi dei criteri negli esempi di API Platform su GitHub.

I tipi di criteri di Apigee sono raggruppati nelle seguenti categorie funzionali:

Gestione del traffico

I criteri nella categoria Gestione del traffico consentono di controllare il flusso dei messaggi di richiesta e risposta tramite un proxy API. Questi criteri supportano i controlli a livello sia operativo che aziendale. Offrono il controllo sulla velocità effettiva non elaborata e possono anche controllare il traffico in base alle singole app. I tipi di criteri di gestione del traffico consentono di applicare le quote e aiutano anche a mitigare gli attacchi denial of service.

Sicurezza

I criteri nella categoria di sicurezza supportano l'autenticazione, l'autorizzazione e la sicurezza basata sui contenuti.

Mediazione

I criteri nella categoria Mediazione consentono di manipolare attivamente i messaggi mentre passano attraverso i proxy API. Consentono di trasformare i formati dei messaggi, da XML a JSON (e viceversa) o di trasformare un formato XML in un altro formato XML. Consentono inoltre di analizzare i messaggi, generare nuovi messaggi e modificare i valori dei messaggi in uscita. Inoltre, i criteri di mediazione interagiscono con i servizi di base esposti da Apigee, consentendoti di recuperare dati su app, sviluppatori, token di sicurezza e prodotti API in fase di runtime.

Estensione

I criteri nella categoria delle estensioni consentono di sfruttare l'estensibilità di Apigee per implementare un comportamento personalizzato nel linguaggio di programmazione che preferisci.

Ogni tipo di criterio è documentato in dettaglio nella Panoramica dei riferimenti ai criteri. Questo argomento illustra l'interazione generale e mostra come creare criteri e come collegarli a Flows in una configurazione proxy API.

Deployment delle modifiche ai criteri

Affinché le modifiche ai criteri abbiano effetto, devi eseguire il deployment della revisione del proxy API in un ambiente. Dopo aver collegato un criterio o aver apportato modifiche a un criterio esistente, utilizza la UI di Apigee o l'API Apigee per eseguire il deployment delle modifiche.

Verificare l'applicazione delle norme

Per verificare che un criterio venga applicato correttamente, l'API deve essere richiamata da un client HTTP. Per verificare questa configurazione di Quota, invia più richieste all'API, superando il limite che hai impostato nei criteri per le quote. (Il percorso URI, configurato come impostazione del percorso di base in ProxyEndpoint, nella richiesta seguente è /weather).

http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

Dopo aver inviato più di una richiesta nell'arco di un minuto, dovresti visualizzare il seguente messaggio di errore:

{  
   "fault":{  
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

Questo indica che il criterio Quota è applicato da Apigee.

Gestione degli errori basata su criteri

Prendi nota del formato del messaggio di errore riportato sopra. Contiene una proprietà faultstring e una proprietà errorcode. In molti casi, per gestire questi errori è necessario implementare un comportamento. Ad esempio, potresti voler inviare un messaggio personalizzato a uno sviluppatore la cui app ha superato il limite di Quota.

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

Best practice: serie di criteri comuni

Per soddisfare i requisiti di gestione di base, i proxy API in genere applicano i seguenti criteri:

Convalida delle chiavi API di base

Flusso di richiesta ProxyEndpoint:
  1. SpikeArrest
  2. XMLThreatProtection o JSONThreatProtection
  3. Convalida delle chiavi API
  4. Quota
  5. ResponseCache
Flusso di risposta ProxyEndpoint:
  1. ResponseCache

Trasformazione di base: da JSON a XML

Flusso di richiesta:
  1. SpikeArrest
  2. JSONThreatProtection
  3. Convalida delle chiavi API
  4. Quota
  5. JSONToXML
Flusso di risposta:
  1. XMLToJSON
  2. ResponseCache