Aggiunta di funzionalità tramite i criteri

Stai visualizzando la documentazione di Apigee X.
Visualizza la documentazione di Apigee Edge.

Apigee ti consente di programmare il comportamento delle API senza scrivere codice utilizzando i criteri. Un criterio è simile a un modulo che implementa una specifica funzione di gestione limitata. I criteri sono progettati per consentire di aggiungere tipi comuni di funzionalità di gestione a un'API in modo semplice e affidabile.

I criteri offrono funzionalità come le funzionalità di sicurezza, di limitazione della frequenza, trasformazione e mediazione, evitando di dover scrivere codice e di gestire questa funzionalità autonomamente. Non sei limitato al set di tipi di criteri forniti da Apigee. Puoi anche scrivere codice e script personalizzati (come le applicazioni JavaScript), che estendono la funzionalità proxy dell'API e ti consentono di innovare con le funzionalità di gestione di base supportate dai criteri Apigee.

Crea e collega i criteri ai proxy API e ai flussi condivisi utilizzando Apigee in VS Code, come descritto nelle seguenti sezioni. A seconda del tipo di criterio, potrebbe essere necessario creare una risorsa, come descritto in Gestire le risorse. Vedi anche Gestire cartelle e file in un'area di lavoro Apigee.

Creazione di una norma

Per creare un criterio utilizzando Apigee in VS Code:

  1. Nella sezione Apigee, esegui una delle seguenti azioni a seconda di dove vuoi collegare il criterio:

    Collega a Azione
    proxy API Esegui una delle seguenti azioni:
    • Posiziona il cursore del mouse su una delle seguenti cartelle, fai clic su Icona Crea e seleziona Crea criterio:
      • Gruppo di proxy apiproxy-name
      • apiproxy-name/apiproxy
    • Posiziona il cursore sulla cartella apiproxy-name/apiproxy/policies relativa al proxy API e fai clic su Icona Crea.
    Flusso condiviso Esegui una delle seguenti azioni:
    • Posiziona il cursore del mouse su una delle seguenti cartelle, fai clic su Icona Crea e seleziona Crea criterio:
      • Gruppo di flussi condiviso sharedflow-name
      • sharedflow-name/sharedflowbundle
    • Posiziona il cursore sulla cartella sharedflow-name/sharedflowbundle/policies per il flusso condiviso e fai clic su Icona Crea.

    Viene visualizzata la procedura guidata di creazione del criterio.

  2. Seleziona dall'elenco la categoria del criterio che vuoi creare.
    Per una descrizione delle categorie delle norme, consulta la Panoramica delle informazioni sulle norme.

  3. Inserisci un nome univoco per il criterio e premi Invio. Il criterio viene aggiunto alla cartella /policies del proxy o del flusso condiviso dell'API nella sezione Apigee e aperto nell'editor.

  4. Modifica il file come richiesto e seleziona File > Salva o ⌘S per salvare le modifiche.
    Per ulteriori informazioni sulla configurazione del criterio, consulta l'articolo Panoramica dei riferimenti relativi ai criteri.

  5. Se necessario, crea le risorse in base al tipo di criterio, come descritto nella sezione Gestione delle risorse.

Collegamento di un criterio a un flusso

I criteri non vengono eseguiti finché non sono collegati a un flusso. Puoi collegare un criterio a un flusso aggiungendo l'elemento <Step> all'elemento del flusso di richiesta o risposta appropriato in una configurazione ProxyEndpoint o TargetEndpoint, come descritto nei seguenti argomenti:

Ad esempio, la seguente configurazione collega un QuotaPolicy a <PreFlow> di ProxyEndpoint per configurare il numero di messaggi di richiesta consentito da un proxy API in un periodo di tempo.

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
  </HTTPProxyConnection>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>