Creazione di un proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Crea un proxy nell'interfaccia utente di Apigee o utilizzando l'API, come descritto nelle sezioni seguenti.

Campi principali del proxy API

Segui queste linee guida quando crei un proxy API:

Campo Descrizione
Nome del proxy API Nome visualizzato per l'API. Specifica caratteri alfanumerici, trattini (-) o trattini bassi (_).
Percorso base del proxy API Frammento URI visualizzato dopo l'indirizzo http://[host] o https://[host] del proxy API. Apigee utilizza l'URI del percorso di base per associare e instradare i messaggi di richiesta in entrata al proxy API appropriato.

Utilizzare i caratteri jolly nei percorsi di base

Utilizza uno o più caratteri jolly nei percorsi base dei proxy API per garantire la compatibilità futura dei proxy API. Consentiamo la specifica di un singolo carattere jolly * tra due barre /: /*/. Ad esempio, un percorso base di /team/*/members consente ai client di chiamare https://[host]/team/blue/members e https://[host]/team/green/members senza dover creare nuovi proxy API per supportare nuovi team. Puoi sostituire un numero qualsiasi di token nel percorso di base seguendo questo pattern. Altri pattern, tra cui /**, /something* o /*something, non sono supportati.
Descrizione (Facoltativo) Una descrizione del proxy API.
URL target/target di backend URL (incluso HTTP o HTTPS) del servizio di backend invocato da questo proxy API.

Passaggi per creare un proxy API

Per creare un proxy API utilizzando l'interfaccia utente o le API:

Apigee nella console Cloud

Per creare un proxy in Apigee nella console Cloud:

  1. Apri la UI di Apigee nella console Cloud in un browser.
  2. Nel riquadro di navigazione a sinistra, fai clic su Sviluppo proxy > Proxy API.
  3. Nel riquadro Proxy API, fai clic su + Crea.
  4. Nel riquadro Crea un proxy, in Modello di proxy, seleziona Proxy inverso (il più comune).
  5. In Dettagli proxy, inserisci quanto segue:
    • Nome proxy:inserisci un nome per il proxy, ad esempio myproxy.
    • Percorso di base: impostato automaticamente sul valore inserito per Proxy name. Il percorso di base fa parte dell'URL utilizzato per inviare richieste all'API. Apigee utilizza l'URL per associare e instradare le richieste in entrata al proxy API appropriato.
    • Descrizione (facoltativa): inserisci una descrizione per il nuovo proxy API, ad esempio "Test di Apigee con un proxy semplice".
    • Destinazione (API esistente): inserisci https://mocktarget.apigee.net. Questo definisce l'URL di destinazione invocato da Apigee su una richiesta al proxy API. Il servizio mocktarget è ospitato su Apigee e restituisce dati semplici. Non richiede una chiave API o un token di accesso.
    • Fai clic su Avanti.
  6. Deployment (facoltativo):
    • Ambienti di deployment: facoltativo. Utilizza le caselle di controllo per selezionare uno o più ambienti in cui implementare il proxy. Se preferisci non eseguire il deployment del proxy in questo momento, lascia vuoto il campo Ambienti di deployment. Puoi sempre eseguire il deployment del proxy in un secondo momento.
    • Service account: facoltativo. Collega un account di servizio al tuo deployment per consentire al proxy di accedere ai servizi Google Cloud, come specificato nel ruolo e nelle autorizzazioni dell'account di servizio.
  7. Fai clic su Crea.

Apigee crea il nuovo proxy e mostra un riepilogo dei dettagli del proxy nella vista Riepilogo proxy.

riquadro di riepilogo di myproxy.

Se scegli di eseguire il deployment del proxy, nella sezione Deployment viene visualizzato il numero di Revisione, che è 1 al primo deployment. La colonna Stato mostra gli ambienti in cui è stato eseguito il deployment del proxy con un indicatore di stato verde.

Apigee classica

Per creare un proxy API semplice nell'interfaccia utente Apigee classica:

  1. Accedi all'interfaccia utente di Apigee.
  2. Fai clic su Proxy API nella visualizzazione principale.
  3. Nell'elenco a discesa Ambiente, seleziona l'ambiente in cui vuoi creare un nuovo proxy API.

    L'interfaccia utente ibrida mostra un elenco di proxy API per l'ambiente. Se non hai ancora creato proxy, l'elenco è vuoto.

  4. Fai clic su Crea nuova.

    Viene avviata la procedura guidata Crea proxy.

  5. Fai clic su Proxy inverso (il più comune).

    Un reverse proxy

    Viene visualizzata la pagina Dettagli proxy.

  6. Configura il proxy con le seguenti impostazioni:
    • Nome: inserisci getstarted. Se esiste già un proxy con questo nome, scegli un altro nome.
    • Percorso di base:lascia invariato il valore /getstarted. Il percorso di base fa parte dell'URL utilizzato per inviare richieste all'API. Apigee utilizza l'URL per associare e instradare le richieste in entrata al proxy API appropriato.
    • (Facoltativo) Descrizione: inserisci una descrizione per il nuovo proxy API, ad esempio Get started API proxy.
    • Destinazione (API esistente): inserisci https://mocktarget.apigee.net. Questo definisce l'URL di destinazione invocato da Apigee su una richiesta al proxy API. Il servizio mocktarget è ospitato su Apigee e restituisce dati semplici. Non richiede una chiave API o un token di accesso.

    I dettagli del proxy API dovrebbero avere il seguente aspetto:

    Dettagli del proxy API

  7. Fai clic su Avanti.
  8. Nella visualizzazione Criteri comuni, in Sicurezza: Autorizzazione, seleziona Trasferimento (nessuna autorizzazione).

    Passa attraverso la selezione

  9. Fai clic su Avanti.
  10. Nella pagina Riepilogo, seleziona gli ambienti di deployment, se vuoi, e fai clic su Crea ed esegui il deployment.

    Crea ed esegui il deployment

    Il nuovo proxy API viene creato e implementato nell'ambiente selezionato.

    Schermata Deployment riuscito

  11. Fai clic su Modifica proxy per visualizzare la scheda Panoramica nell'editor proxy.

    12. Modifica elenco proxy

Nell'elenco dei proxy API, lo stato del deployment del proxy API getstarted è verde per l'ambiente test.

Mostra l'elenco dei proxy API. Lo stato di deployment di getstarted è verde.

API Apigee

Crea un proxy API nella tua organizzazione Apigee inviando una richiesta POST alla seguente risorsa:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

Devi definire il nome del proxy API utilizzando il parametro di query name. Limita i caratteri utilizzati nel nome a quanto segue: A-Za-z0-9._\-$ %

Se vuoi, puoi importare un pacchetto di configurazione di proxy API seguendo questi passaggi:

  • Imposta il parametro di query action su import
  • Imposta l'intestazione Content-type su multipart/form-data
  • Passa il nome del pacchetto di configurazione del proxy API nel file system locale

Il seguente esempio mostra come creare un proxy API importando un pacchetto di configurazione del proxy API (helloworld-config.zip) nel file system locale utilizzando l'API.

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste all'API Apigee.

Di seguito è riportato un esempio di output della risposta:

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

Per saperne di più sulla creazione di un proxy API, consulta il metodo apis.create nell'API Apigee. Per visualizzare tutti i metodi disponibili per i proxy API, consulta l'API Proxy API.

Passaggi successivi

Dopo aver creato un proxy API semplice, in genere esegui una delle seguenti operazioni: