Creazione di un proxy API

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Crea un proxy nella UI di Apigee o utilizzando l'API, come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per creare un proxy in Apigee nella console Cloud:

  1. Apri l'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 Inverti proxy (più comune).
  5. In Dettagli proxy, inserisci quanto segue:
    • Nome del 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 è la parte dell'URL utilizzato per effettuare richieste all'API. Apigee utilizza l'URL per abbinare e instradare le richieste in entrata al proxy API appropriato.
    • Descrizione (facoltativo): inserisci una descrizione per il nuovo proxy API, ad esempio "Test di Apigee con un proxy semplice".
    • Target (API esistente): inserisci https://mocktarget.apigee.net. Definisce l'URL di destinazione che Apigee richiama su una richiesta al proxy API. Il servizio mocktarget è ospitato su Apigee e restituisce dati semplici. Non richiede chiavi API o token di accesso.
    • Fai clic su Avanti.
  6. Fai clic su Avanti.
  7. (Facoltativo) Esegui il deployment:
    • Ambienti di deployment: facoltativo. Utilizza le caselle di controllo per selezionare uno o più ambienti in cui eseguire il deployment del proxy. Se preferisci non eseguire il deployment del proxy a questo punto, lascia vuoto il campo Ambienti di deployment. Puoi sempre eseguire il deployment del proxy in un secondo momento.
    • Account di servizio: facoltativo. Collega un account di servizio al deployment per consentire al proxy di accedere ai servizi Google Cloud, come specificato nel ruolo e nelle autorizzazioni dell'account di servizio.
  8. Fai clic su Crea.

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

riquadro di riepilogo myproxy.

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

Versione classica di Apigee

Per creare un semplice proxy API nella UI classica di Apigee:

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

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

  4. Fai clic su Crea nuovo.

    Viene avviata la procedura guidata Crea proxy.

  5. Fai clic su Inverti proxy (più comune).

    Un proxy inverso

    Viene visualizzata la pagina Dettagli del proxy.

  6. Configura il proxy con le seguenti impostazioni:
    • Nome: inserisci getstarted. Se esiste già un proxy con questo nome, scegli un altro nome.
    • Base Path: (Percorso di base): lascia impostato il valore /getstarted. Il percorso di base è la parte dell'URL utilizzato per effettuare richieste all'API. Apigee utilizza l'URL per abbinare 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.
    • Target (API esistente): inserisci https://mocktarget.apigee.net. Definisce l'URL di destinazione che Apigee richiama su una richiesta al proxy API. Il servizio mocktarget è ospitato su Apigee e restituisce dati semplici. Non richiede chiavi API o token di accesso.

    I dettagli del proxy API dovrebbero essere simili ai seguenti:

    Dettagli proxy API

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

    Selezione del passaggio

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

    Crea ed esegui il deployment

    Viene creato e eseguito il deployment del nuovo proxy API 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 di deployment del proxy API getstarted è verde per l'ambiente test.

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

API Apigee

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

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

Devi definire il nome del proxy API utilizzando il parametro di query name. Limita il numero di caratteri utilizzati nel nome ai seguenti: A-Za-z0-9._\-$ %

Facoltativamente, puoi importare un bundle di configurazione 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 bundle di configurazione del proxy API sul file system locale

L'esempio seguente mostra come creare un proxy API importando un bundle di configurazione del proxy API (helloworld-config.zip) sul file system locale tramite 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 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 Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'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 ulteriori informazioni 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 la pagina dedicata all'API dei proxy API.

Passaggi successivi

Dopo aver creato un semplice proxy API, di solito esegui una delle seguenti operazioni: