Creazione di un proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Nota: negli ambienti abilitati per i deployment di archiviazione, non puoi sviluppare proxy API utilizzando la UI, l'API o gcloud di Apigee. Per sviluppare proxy API per i deployment di archiviazione utilizzando Apigee in VS Code,consulta Sviluppo di proxy API utilizzando Apigee in VS Code.

Crea un proxy nell'interfaccia utente 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, trattino (-) o trattino basso (_). Nota:il nome del proxy API non deve corrispondere al nome di alcun proxy API nell'organizzazione che può essere sottoposto a deployment in un ambiente con il deployment del proxy abilitato.
Percorso di base del proxy API	Frammento URI che viene visualizzato dopo l'indirizzo http://[host] o https://[host] del proxy API. Apigee utilizza l'URI del percorso di base per abbinare e instradare i messaggi di richiesta in entrata al proxy API corretto. Nota: il percorso di base deve essere univoco. Non puoi eseguire il deployment di due proxy API con lo stesso percorso di base. Se modifichi un proxy API di cui è stato eseguito il deployment e imposti il percorso di base sullo stesso valore del percorso di base di un altro proxy API, Apigee annulla automaticamente il deployment del proxy API quando lo salvi. Prima di poter eseguire nuovamente il deployment del proxy API, devi modificare il percorso di base in modo che sia univoco. Utilizzare i caratteri jolly nei percorsi di base Utilizza uno o più caratteri jolly nei percorsi di base del proxy API per proteggere i tuoi proxy API in futuro. Consentiamo la specifica di un singolo carattere jolly * tra due barre /: /*/. Ad esempio, un percorso di base /team/*/members consente ai client di chiamare https://[host]/team/blue/members e https://[host]/team/green/members senza che tu debba creare nuovi proxy API per supportare nuovi team. Puoi sostituire qualsiasi numero di token nel percorso di base seguendo questo pattern. Altri pattern, inclusi /**, /something* o /*something, non sono supportati.
Descrizione	(Facoltativo) Una descrizione del proxy API.
URL di destinazione/di backend	URL (incluso HTTP o HTTPS) del servizio di backend richiamato da questo proxy API.
Spazio	(Facoltativo) Se la tua organizzazione ha abilitato Apigee Spaces, puoi associare il proxy API a uno spazio. Per saperne di più, vedi Panoramica di Apigee Spaces.

Passaggi per creare un proxy API

Per creare un proxy API utilizzando la UI o le API:

Apigee nella console Cloud

Per creare un proxy in Apigee nella console Google Cloud:

1. Nella console Google Cloud , vai alla pagina Sviluppo proxy > Proxy API.

   Vai ai proxy API

Nota:se visualizzi la pagina Benvenuto in Apigee API Management, devi provisionare la tua organizzazione Apigee prima di procedere.

Dopo aver eseguito il provisioning di Apigee, chiudi la UI e riapri la UI di Apigee nella console Cloud.

2. Nel riquadro Proxy API, fai clic su + Crea.
3. Nel riquadro Crea un proxy, in Modello di proxy, seleziona Proxy inverso (più comune).
4. Nella sezione Dettagli proxy, inserisci quanto segue:
   • Nome proxy:inserisci un nome per il proxy, ad esempio myproxy.
   • Base Path (Percorso di base): impostato automaticamente sul valore inserito per Proxy name. Il percorso di base fa parte dell'URL utilizzato per effettuare richieste alla tua API. Apigee utilizza l'URL per corrispondere 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 in una richiesta al proxy API. Il servizio mocktarget è ospitato su Apigee e restituisce dati semplici. Non richiede chiavi API o token di accesso.
   • Spazio (facoltativo): se la tua organizzazione ha attivato Apigee Spaces, puoi associare il proxy API a uno spazio selezionato dall'elenco delle opzioni disponibili. Per saperne di più, vedi Panoramica di Apigee Spaces.
   • Fai clic su Avanti.
5. Deployment (facoltativo):
   • 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 in questo punto, 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 deployment per consentire al proxy di accedere ai servizi Google Cloud , come specificato nel ruolo e nelle autorizzazioni del account di servizio.
6. Fai clic su Crea.

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

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

Apigee classico

Per creare un proxy API semplice nella UI Apigee classica:

1. Accedi alla UI Apigee.
2. Fai clic su Proxy API nella visualizzazione 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 quell'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 Reverse proxy (il più comune).

   

   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 nome diverso.
   • Percorso di base:lascia impostato il valore /getstarted. Il percorso di base fa parte dell'URL utilizzato per effettuare richieste alla tua API. Apigee utilizza l'URL per corrispondere 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 in 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 essere simili ai seguenti:

   

7. Fai clic su Avanti.
8. Nella visualizzazione Policy comuni, seleziona Pass-through (nessuna autorizzazione) in Sicurezza: Autorizzazione.

   

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.

    

    Nota:se non selezioni un ambiente di seguito in Deployment facoltativo, il pulsante in basso a destra è etichettato semplicemente Crea.
    Nota:dopo aver eseguito il deployment di una revisione del proxy API, non puoi modificarla. Per modificare il proxy API, devi creare e implementare una nuova revisione.

    Per questo motivo, puoi scegliere di creare il proxy API senza eseguirne il deployment in alcun ambiente. Puoi modificare il proxy API ed eseguirne il deployment in un secondo momento, come descritto in Passaggi successivi.

    Il nuovo proxy API viene creato e sottoposto a deployment nell'ambiente selezionato.

    

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

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

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 ai seguenti: A-Za-z0-9._\-$ %

(Facoltativo) Puoi importare un pacchetto di configurazione del proxy API seguendo questi passaggi:

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

L'esempio seguente 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 la sezione Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato 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 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:

• Aggiungi criteri, sicurezza e altre funzionalità della piattaforma Apigee, come descritto in Informazioni sulle API e sui proxy API.
• Esegui il deployment nel tuo cluster, come descritto in Eseguire il deployment di un proxy API.