Crea un proxy API configurabile

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Con i proxy API configure^PREVIEW, gli utenti di Apigee possono creare ed eseguire il deployment di un proxy leggero utilizzando una configurazione dichiarativa, simile al modello di risorse Kubernetes. In questa pagina vengono descritti i passaggi necessari per creare un proxy configurabile e eseguirne il deployment utilizzando il nuovo meccanismo di deployment basato su archivio.

Per scoprire di più sui proxy API Configurabile^PREVIEW, vedi Proxy API configurabili.

Lo sviluppo di proxy API Configurabile^ANTEPRIMA è disponibile solo per i clienti con organizzazioni con abbonamenti a pagamento Apigee. I clienti Apigee con organizzazioni con Pay-as-you-go possono creare proxy API programmabili.

Prima di iniziare

Questo tutorial presuppone che tu abbia già eseguito il provisioning di un'organizzazione Apigee e installato Apigee. In caso contrario, consulta la pagina Introduzione al provisioning per i passaggi necessari per installare e configurare Apigee prima di procedere.

Prima di iniziare questo tutorial, completa i seguenti passaggi aggiuntivi:

Verifica che Cloud SDK sia stato scaricato e installato sulla tua macchina.
Scarica Cloud SDK
Aggiorna gcloudcomponenti:
```
gcloud components update
```
Conferma le credenziali di Apigee e i dettagli dell'organizzazione, poiché saranno necessari per eseguire il provisioning di un ambiente per il proxy API configurabile.

Esegui il provisioning di un ambiente Apigee

Prima di creare la configurazione del proxy, devi eseguire il provisioning di un ambiente Apigee che supporti i proxy configurabili. Un ambiente è un contesto di esecuzione di runtime per i proxy API e i flussi condivisi in un'organizzazione. Devi eseguire il deployment di un proxy API in un ambiente prima di potervi accedere. Puoi eseguire il deployment di un proxy API in un singolo ambiente o in più ambienti.

Per maggiori dettagli, vedi Informazioni sugli ambienti e sui gruppi di ambienti.

Per creare un nuovo ambiente nella UI:

Apri l'UI di Apigee in un browser.
Seleziona Amministratore > Ambienti > Panoramica nel menu di navigazione a sinistra.
La UI mostra un insieme di schede, ognuna delle quali rappresenta un ambiente esistente:

Se è la prima volta che accedi alla vista Ambiente, non ci saranno ambienti.
Fai clic su +AMBIENTE.

Viene visualizzata la finestra di dialogo Nuovo ambiente:
Inserisci le informazioni seguenti nella finestra di dialogo Nuovo ambiente:
1. Nome visualizzato: un nome descrittivo per l'ambiente utilizzato nella UI. Ad esempio, My Test Environment.
2. Nome ambiente: il nome della pubblicità programmatica per l'ambiente. Questo valore farà parte dell'URL della richiesta per i proxy API e non deve contenere spazi o altri caratteri speciali. Può contenere solo lettere, numeri e trattini. Ad esempio, my-environment-1.
  
  Una volta creato, il nome del nuovo ambiente non può essere modificato.
3. Descrizione (facoltativa): informazioni aggiuntive sull'ambiente che vuoi aggiungere come promemoria.
4. Tipo di deployment (anteprima): seleziona Archivia come tipo di deployment.
  Nota: il tipo di deployment utilizzato con questo ambiente non può essere modificato dopo la creazione dell'ambiente.
Tutti i campi tranne Description sono obbligatori.
Fai clic su Ok.

La scheda mostra lo stato Provisioning in attesa mentre Apigee crea il nuovo ambiente, come mostrato nell'esempio seguente:

Potrebbe verificarsi un ritardo di diversi minuti prima che venga eseguito il provisioning del nuovo ambiente.

Al termine, l'interfaccia utente di Apigee mostra il nuovo ambiente come una scheda con gli altri ambienti che hai creato:

Collega l'ambiente a un'istanza Apigee

Dopo aver creato un nuovo ambiente, devi collegarlo all'istanza Apigee affinché sia accessibile. Puoi eseguire questa operazione tramite l'interfaccia utente quando crei una nuova istanza (se l'ambiente esiste già). In questo caso, se hai già creato un'istanza in precedenza, puoi collegare il nuovo ambiente utilizzando l'API di creazione dei collegamenti delle istanze.

Per un esempio del processo, vedi Creare un ambiente nella documentazione relativa al provisioning dalla riga di comando.

Per questo tutorial, puoi utilizzare il seguente comando:

operation_name=$(curl -s -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/organizations/PROJECT_ID/instances/INSTANCE_NAME/attachments" \
  -X POST -H "content-type:application/json"\
  -d '{"environment":"ENV_NAME"}' | jq -r '.name' )

Dove:

PROJECT_ID è l'ID del progetto Cloud in cui è stato creato l'ambiente Apigee. Deve essere uguale al nome della tua organizzazione Apigee.
INSTANCE_NAME è il nome della tua istanza Apigee.
ENV_NAME è il nome dell'ambiente in cui verrà eseguito il deployment del proxy API configurabile.

Questa operazione restituisce un'operazione a lunga esecuzione. Puoi eseguire il polling dell'operazione con il comando seguente finché l'output non mostra che l'operazione è done: true.

curl -s -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/$operation_name"

Configurare un gruppo di ambienti

Un gruppo di ambienti (a volte chiamato envgroup nelle API Apigee) è il meccanismo di base per definire il modo in cui le richieste vengono instradate ai singoli ambienti. Devi definire i nomi host sui gruppi di ambienti (non sui singoli ambienti) e Apigee instrada le richieste agli ambienti all'interno di un gruppo utilizzando le relative definizioni.

Gli ambienti non assegnati ai gruppi non hanno nomi host che vi rimandano, pertanto non sono accessibili. Per saperne di più, consulta Creazione di gruppi di ambienti.

Per configurare un gruppo di ambienti per il nuovo ambiente:

Nell'interfaccia utente di Apigee, seleziona Amministratore > Ambienti > Gruppi.
Fai clic su +Gruppo di ambienti:

Viene visualizzata la finestra di dialogo Aggiungi un gruppo di ambienti.
Inserisci un nome per il nuovo gruppo di ambienti:

Il nome può contenere solo lettere minuscole, numeri e trattini. Inoltre, deve iniziare con una lettera, avere una lunghezza di almeno due caratteri e non può terminare con un trattino. I nomi validi includono my-env-group e prod2.
Fai clic su Aggiungi.
Apigee crea un nuovo gruppo di ambienti. Questa operazione di solito è molto rapida.

Se l'operazione è andata a buon fine, Apigee conferma che il gruppo è stato creato con un banner simile al seguente:

Apigee assegna anche un nome host predefinito al nuovo gruppo.
(Facoltativo) Assegna altri nomi host al nuovo gruppo facendo clic su per il gruppo in questione.

Apigee visualizza il riquadro Dettagli gruppo di ambienti:
Aggiungi nomi host al campo Hostnames (Nomi host). Ogni nome host deve essere inserito su una riga separata.
Al termine, fai clic su Salva.

Puoi aggiungere e rimuovere nomi host da questo elenco in qualsiasi momento utilizzando la stessa procedura.

Crea l'archivio proxy

Per creare un archivio proxy API Configurabile^PREVIEW:

Nel tuo ambiente locale, crea una directory per archiviare l'area di lavoro Apigee nel file system locale. Questa directory sarà la base della struttura dei file proxy API Configurabile^PREVIEW, come mostrato di seguito:

.
└── src
    └── main
        └── apigee
            ├── apiproxies
            │   ├── <proxy-name>
            │   │   └── config.yaml
            │   ├── <proxy-name>
            │   │   └── config.yaml
            └── environments
                ├── <env-name>
                │   ├── deployments.json
                │   └── targetservers.json

mkdir -p SOURCE_DIR/src/main/apigee/apiproxies/PROXY_NAME

dove:

SOURCE_DIR è il nome della directory di archiviazione.
PROXY_NAME è il nome del proxy configurabile.

Ad esempio:

mkdir -p my-dir/src/main/apigee/apiproxies/my-proxy

Crea un nuovo file per la configurazione del proxy con il seguente comando:
```
vi SOURCE_DIR/src/main/apigee/apiproxies/PROXY_NAME/config.yaml
```
Ad esempio:
```
vi my-dir/src/main/apigee/apiproxies/my-proxy/config.yaml
```
Il file di configurazione del proxy deve utilizzare uno dei seguenti nomi di file:
- config.yaml
- config.json
- config.yml

Copia la seguente configurazione proxy nel nuovo file config.yaml:

# config.yaml

basepath: "/helloworld"
operations:
- id: get-user
  http_match:
  - path_template: "/user"
    method: GET
target:
  uri: "https://mocktarget.apigee.net"

Crea un file deployments.json utilizzando il seguente comando:

vi SOURCE_DIR/src/main/apigee/environments/ENV_NAME/deployments.json

Ad esempio:

vi my-dir/src/main/apigee/environments/prod/deployments.json

Copia quanto segue nel nuovo file deployments.json:

{
  "proxies" : ["PROXY_NAME"]
}

Per altri esempi, vedi Esempi di configurazione del proxy configurabile.

Esegui il deployment dell'archivio

Per eseguire il deployment di un archivio in un ambiente Apigee, utilizza il seguente comando gcloud:

gcloud alpha apigee archives deploy \
--organization=PROJECT_ID \
--environment=ENV_NAME \
--source=SOURCE_DIR

Ad esempio:

gcloud alpha apigee archives deploy \
--organization=my-project \
--environment=prod \
--source=my-dir

Devi specificare l'ambiente Apigee in cui vuoi eseguire il deployment dell'archivio utilizzando il flag --environment. L'ambiente Apigee deve essere abilitato per i deployment di archiviazione.

Per saperne di più sulla gestione dei deployment degli archivi, consulta Deployment e gestione degli archivi in un ambiente Apigee.

Controlla lo stato del deployment dell'archivio

Per controllare lo stato del deployment dell'archivio, utilizza il comando gcloud alpha apigee Operations.

L'esempio seguente mostra che lo stato del deployment dell'archivio per l'operazione con ID di revisione 439fa3f7-6aa4-42ad-8b12-3ca912c75d5c è IN_PROGRESS.

gcloud alpha apigee operations describe b64c2665-b5ac-43cc-9e2d-232e8895c2ed

Di seguito viene fornito un esempio della risposta:

Using Apigee organization 'myorg'
Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done.

Per ulteriori informazioni su come elencare i deployment di archiviazione, visualizzare i dettagli dei deployment o eliminare un ambiente con deployment di archiviazione, consulta Deployment e gestione degli archivi in un ambiente Apigee.