Che cos'è un criterio?

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

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

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

Guarda questo video per un'introduzione al collegamento e all'applicazione delle norme.

Tipi di criteri

Tecnicamente, un criterio è un file di configurazione in formato XML. Struttura di ogni tipo di criterio (ad es. gli elementi di configurazione obbligatori e facoltativi) viene definito da un Schema XML. Se conosci bene gli strumenti XML, vale la pena familiarizzare con gli schemi delle norme Esempi della piattaforma API su GitHub.

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

Gestione del traffico

I criteri nella categoria di gestione del traffico consentono di controllare il flusso di richieste e i messaggi di risposta tramite un proxy API. Questi criteri supportano sia operazioni a livello aziendale. Ti offrono il controllo sulla velocità effettiva non elaborata e possono anche controllare il traffico per le singole app. I tipi di criteri di gestione del traffico consentono di applicare le quote e anche e ti aiutano a mitigare gli attacchi DoS.

Sicurezza

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

Mediazione

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

Estensione

I criteri nella categoria di estensione ti 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 nel Panoramica della sezione Riferimento alle norme. Questo argomento illustra un'interazione generale e mostra come creare norme e come collegarli ai flussi 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 apportato modifiche a un criterio esistente, utilizza la UI di Apigee o API Apigee per eseguire il deployment delle modifiche.

Verificare l'applicazione dei criteri

Per verificare che un criterio venga applicato correttamente, l'API deve essere richiamata da un client HTTP. A verifica questa configurazione Quota, invia più richieste all'API, superando il limite di quota che hai impostato nel criterio per le quote. (il percorso dell'URI, configurato come impostazione del percorso di base nella ProxyEndpoint, nella richiesta in basso è /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 errore messaggio:

{  
   "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, è necessario implementare un comportamento per a gestire questi errori. Ad esempio, potresti voler inviare un messaggio personalizzato a uno sviluppatore la cui l'app ha superato Quota.

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

Best practice: serie di norme comuni

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

Chiave API di base convalida

Flusso di richiesta ProxyEndpoint:
    .
  1. SpikeArrest
  2. XMLThreatProtection o JSONThreatProtection
  3. Convalida delle chiavi API
  4. Quota
  5. ResponseCache
Flusso di risposta degli endpoint proxy:
  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