Iniziare a utilizzare Cloud Endpoints per l'ambiente flessibile di App Engine con ESP

---

Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy (ESP) in esecuzione su un'istanza nell'ambiente flessibile di App Engine. L'API REST del codice campione è descritta utilizzando la specifica OpenAPI. Il tutorial mostra anche come creare una chiave API e utilizzarla nelle richieste all'API.

Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints e Architettura di Endpoints.

Obiettivi

Utilizza il seguente elenco di attività di alto livello mentre segui il tutorial. Tutte le attività sono necessarie per inviare correttamente le richieste all'API.

1. Configura un progetto Google Cloud , installa il software richiesto e crea un'app App Engine. Consulta la sezione Prima di iniziare.
2. Scarica il codice campione. Consulta la sezione Recupera il codice di esempio.
3. Configura il file openapi-appengine.yaml, utilizzato per configurare Endpoints. Vedi Configurazione di Endpoints.
4. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Vedi Deployment della configurazione di Endpoints.
5. Esegui il deployment dell'API e di ESP in App Engine. Consulta Esegui il deployment del backend dell'API.
6. Invia una richiesta all'API. Consulta Invio di una richiesta all'API.
7. Monitora l'attività dell'API. Consulta Monitorare l'attività dell'API.
8. Evita che al tuo account Google Cloud vengano addebitati costi. Vedi Pulizia.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

• App Engine
• Endpoints

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il calcolatore prezzi.

I nuovi utenti di Google Cloud potrebbero avere diritto a una prova senza costi.

Al termine delle attività descritte in questo documento, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per ulteriori informazioni, vedi Pulizia.

Prima di iniziare

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. Prendi nota dell'ID progetto perché ti servirà in seguito.

2. Per inviare richieste all'API di esempio, devi disporre di un'applicazione.

   • Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di curl, che in genere è preinstallato sul sistema operativo. Se non hai curl, puoi scaricarlo dalla curl pagina di download e release.
   • Utenti Windows: questo tutorial fornisce un esempio che utilizza Invoke-WebRequest, che è supportato in PowerShell 3.0 e versioni successive.
3. Scarica Google Cloud CLI.
4. Aggiorna gcloud CLI e installa i componenti di Endpoints.

   gcloud components update

5. Assicurati che Google Cloud CLI (gcloud) sia autorizzata ad accedere ai tuoi dati e servizi su Google Cloud:

   gcloud auth login

   Nella nuova scheda del browser che si apre, seleziona un account.
6. Imposta il progetto predefinito sull'ID progetto.

   gcloud config set project YOUR_PROJECT_ID

   Sostituisci YOUR_PROJECT_ID con l'ID progetto. Se hai altri progetti Google Cloud e vuoi utilizzare gcloud per gestirli, consulta Gestione delle configurazioni di gcloud CLI.

7. Seleziona la regione in cui vuoi creare l'applicazione App Engine. Esegui questo comando per ottenere un elenco di regioni:

   gcloud app regions list

8. Crea un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloude YOUR_REGION con la regione in cui vuoi creare l'applicazione App Engine.

     gcloud app create \
     --project=YOUR_PROJECT_ID \
     --region=YOUR_REGION
   

9. Se il account di servizio predefinito di App Engine non dispone del ruolo Editor (roles/editor), concedi le seguenti autorizzazioni:
   • Concedi roles/servicemanagement.serviceConsumer al account di servizio predefinito App Engine a livello di servizio.
   • Concedi roles/servicemanagement.serviceController all'account di servizio predefinito App Engine a livello di progetto.

   Per informazioni sulla concessione dei ruoli al account di servizio, consulta Gestire l'accesso utilizzando la console Google Cloud .

recupera il codice di esempio

Java

Per clonare o scaricare l'API di esempio:

1. Il codice campione utilizza Maven. Se non hai Maven 3.3.9 o versioni successive, scaricalo e installalo.
2. Clona il repository dell'app di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples

   In alternativa, scarica il campione come file ZIP ed estrailo.

3. Passa alla directory che contiene il codice di esempio:

   cd java-docs-samples/endpoints/getting-started

Python

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples

   In alternativa, scarica il campione come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd python-docs-samples/endpoints/getting-started

Vai

Per clonare o scaricare l'API di esempio:

1. Assicurati che la variabile di ambiente GOPATH sia impostata.
2. Clona il repository dell'app di esempio sulla tua macchina locale:

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. Passa alla directory che contiene il codice di esempio:

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples

   In alternativa, scarica il campione come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd php-docs-samples/endpoints/getting-started

Ruby

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

   In alternativa, scarica il campione come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

Per clonare o scaricare l'API di esempio:

1. Clona il repository dell'app di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

   In alternativa, scarica il campione come file ZIP ed estrailo.

2. Passa alla directory che contiene il codice di esempio:

   cd nodejs-docs-samples/endpoints/getting-started

Configurazione di Endpoints

Il codice campione include il file di configurazione OpenAPI, openapi-appengine.yaml, basato sulla specifica OpenAPI v2.0.

Per configurare Endpoints:

1. Nella directory codice campione, apri il file di configurazione openapi-appengine.yaml.
   Java

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Vai

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   NodeJS

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Tieni presente quanto segue:

   • L'esempio di configurazione mostra le righe vicino al campo host che devi modificare. Per eseguire il deployment di openapi-appengine.yaml in Endpoints, è necessario il documento OpenAPI completo.
   • L'esempio openapi-appengine.yaml contiene una sezione per configurare l'autenticazione che non è necessaria per questo tutorial. Non devi configurare le righe con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
   • OpenAPI è una specifica indipendente dal linguaggio. Per comodità, lo stesso file openapi-appengine.yaml si trova nell'esempio getting-started in ogni repository GitHub della lingua.

2. Nella riga con il campo host, sostituisci YOUR-PROJECT-ID con l'ID del tuo progetto Google Cloud . Ad esempio:

   host: "example-project-12345.appspot.com"

Endpoints utilizza il testo configurato nel campo host come nome del servizio. Quando esegui il deployment dell'API nel backend App Engine, viene creata automaticamente una voce DNS con un nome nel formato YOUR-PROJECT-ID.appspot.com.

Per informazioni sui campi nel documento OpenAPI richiesti da Endpoints, vedi Configurazione di Endpoints.

esegui il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione di Endpoints, utilizza il comando gcloud endpoints services deploy. Questo comando utilizza Service Management per creare un servizio gestito.

Per eseguire il deployment della configurazione di Endpoints:

1. Assicurati di trovarti nella directory endpoints/getting-started.
2. Carica la configurazione e crea un servizio gestito:

   gcloud endpoints services deploy openapi-appengine.yaml
   

Il comando gcloud chiama quindi l'API Service Management per creare un servizio gestito con il nome specificato nel campo host del file openapi-appengine.yaml. Service Management configura il servizio in base alle impostazioni nel file openapi-appengine.yaml. Quando apporti modifiche a openapi-appengine.yaml, devi eseguire nuovamente il deployment del file per aggiornare il servizio Endpoints.

Durante la creazione e la configurazione del servizio, Service Management visualizza le informazioni nel terminale. Puoi ignorare tranquillamente gli avvisi sui percorsi nel file openapi-appengine.yaml che non richiedono una chiave API. Al termine della configurazione del servizio, Service Management visualizza un messaggio con l'ID configurazione del servizio e il nome del servizio, simile al seguente:

Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]

Nell'esempio precedente, 2017-02-13r0 è l'ID di configurazione del servizio e example-project-12345.appspot.com è il servizio Endpoints. L'ID configurazione del servizio è composto da un timestamp seguito da un numero di revisione. Se esegui di nuovo il deployment del file openapi-appengine.yaml nello stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoints > Servizi nella console Google Cloud .

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints.

Controllo dei servizi richiesti

Come minimo, Endpoints ed ESP richiedono l'abilitazione dei seguenti servizi Google:

Nome	Titolo
servicemanagement.googleapis.com	API Service Management
servicecontrol.googleapis.com	API Service Control

Nella maggior parte dei casi, il comando gcloud endpoints services deploy attiva questi servizi richiesti. Tuttavia, il comando gcloud viene completato correttamente, ma non abilita i servizi richiesti nelle seguenti circostanze:

• Se hai utilizzato un'applicazione di terze parti come Terraform e non includi questi servizi.

• Hai eseguito il deployment della configurazione di Endpoints in un progettoGoogle Cloud esistente in cui questi servizi sono stati disattivati in modo esplicito.

Utilizza questo comando per verificare che i servizi richiesti siano abilitati:

gcloud services list

Se non vedi i servizi richiesti elencati, attivali:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Abilita anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare il ENDPOINTS_SERVICE_NAME puoi:

• Dopo aver eseguito il deployment della configurazione di Endpoints, vai alla pagina Endpoints nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME viene visualizzato nella colonna Nome servizio.

• Per OpenAPI, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo name della configurazione di gRPC Endpoints.

Per saperne di più sui comandi gcloud, consulta servizi gcloud.

esegui il deployment del backend dell'API

Finora hai eseguito il deployment del documento OpenAPI in Service Management, ma non hai ancora eseguito il deployment del codice che gestisce il backend dell'API. Questa sezione illustra come eseguire il deployment dell'API di esempio e di ESP in App Engine.

Per eseguire il deployment del backend dell'API:

1. Aggiungi il nome del servizio al file app.yaml:
   Java

   Apri il file endpoints/getting-started/src/main/appengine/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Python

   Apri il file endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Vai

   Apri il file endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   PHP

   Apri il file endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
     # previously run the deploy command, you can list your existing configuration
     # ids using the 'configs list' command as follows:
     #
     #     gcloud endpoints configs list --service=YOUR-PROJECT-ID.appspot.com
     #
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Ruby

   Apri il file endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   NodeJS

   Apri il file endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Sostituisci ENDPOINTS-SERVICE-NAME con il nome del tuo servizio Endpoints. Si tratta dello stesso nome che hai configurato nel campo host del documento OpenAPI. Ad esempio:

   endpoints_api_service:
     name: example-project-12345.appspot.com
     rollout_strategy: managed

   L'opzione rollout_strategy: managed configura ESP in modo che utilizzi la configurazione del servizio di cui è stato eseguito il deployment più recente. Quando specifichi questa opzione, fino a 5 minuti dopo il deployment di una nuova configurazione del servizio, ESP rileva la modifica e inizia a utilizzarla automaticamente. Ti consigliamo di specificare questa opzione anziché un ID configurazione specifico da utilizzare per ESP.

2. Salva il file app.yaml.

Poiché la sezione endpoints_api_service è inclusa nel file app.yaml, il comando gcloud app deploy esegue il deployment e configura ESP in un container separato nell'ambiente flessibile App Engine. Tutto il traffico delle richieste viene instradato tramite ESP, che inoltra le richieste e le risposte da e verso il container che esegue il codice del server di backend.

3. Assicurati di trovarti nella directory endpoints/getting-started. Qui si trova il file di configurazione di openapi-appengine.yaml.
4. Esegui questo comando per eseguire il deployment dell'API di esempio e di ESP in App Engine:
Java
Esegui il deployment utilizzando Maven:
mvn appengine:stage
gcloud app deploy target/appengine-staging
Python
gcloud app deploy
Vai
gcloud app deploy
PHP
gcloud app deploy
Ruby
gcloud app deploy
NodeJS
gcloud app deploy

Il comando gcloud app deploy crea un record DNS nel formato YOUR_PROJECT_ID.appspot.com, che utilizzi quando invii richieste all'API. Ti consigliamo di attendere alcuni minuti prima di inviare richieste alla tua API mentre App Engine viene inizializzato completamente.

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di deployment in ambienti flessibili di App Engine.

Per saperne di più, vedi Deployment del backend dell'API.

invia richieste all'API

Ora che il servizio è in esecuzione su App Engine, puoi inviargli richieste.

Crea una chiave API e imposta una variabile di ambiente

Il codice campione richiede una chiave API. Per semplificare la richiesta, imposta una variabile di ambiente per la chiave API.

1. Nello stesso progetto Google Cloud che hai utilizzato per l'API, crea una chiave API nella pagina delle credenziali API. Se vuoi creare una chiave API in un altro Google Cloud progetto, consulta Abilitare un'API nel tuo Google Cloud progetto.

   Vai alla pagina Credenziali

2. Fai clic su Crea credenziali e poi seleziona Chiave API.
3. Copia la chiave negli appunti.
4. Fai clic su Chiudi.
5. Sul computer locale, incolla la chiave API per assegnarla a una variabile di ambiente:
   • In Linux o macOS: export ENDPOINTS_KEY=AIza...
   • In Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Invia la richiesta

Linux o Mac OS

1. Crea una variabile di ambiente per l'URL del progetto App Engine. Sostituisci YOUR_PROJECT_ID con l'Google Cloud ID progetto:

   export ENDPOINTS_HOST=https://YOUR_PROJECT_ID.appspot.com

2. Invia una richiesta HTTP utilizzando le variabili di ambiente ENDPOINTS_HOST e ENDPOINTS_KEY che hai impostato in precedenza:

   curl --request POST \
     --header "content-type:application/json" \
     --data '{"message":"hello world"}' \
     "${ENDPOINTS_HOST}/echo?key=${ENDPOINTS_KEY}"

Nella curl precedente:

• L'opzione --data specifica i dati da pubblicare nell'API.
• L'opzione --header specifica che i dati sono in formato JSON.

PowerShell

1. Crea una variabile di ambiente per l'URL del progetto App Engine. Sostituisci YOUR_PROJECT_ID con l'Google Cloud ID progetto:

   $Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"

2. Invia una richiesta HTTP utilizzando le variabili di ambiente ENDPOINTS_HOST e ENDPOINTS_KEY che hai impostato in precedenza:

   (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
       -Headers @{"content-type"="application/json"} `
       -URI "$Env:ENDPOINTS_HOST/echo?key=$Env:ENDPOINTS_KEY").Content
   

Nell'esempio precedente, le prime due righe terminano con un accento grave. Quando incolli l'esempio in PowerShell, assicurati che non ci sia uno spazio dopo gli apici inversi. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, consulta Invoke-WebRequest nella documentazione di Microsoft.

App di terze parti

Puoi utilizzare un'applicazione di terze parti come l'estensione del browser Chrome Postman per inviare la richiesta:

• Seleziona POST come verbo HTTP.
• Per l'intestazione, seleziona la chiave content-type e il valore application/json.
• Per il corpo, inserisci quanto segue:
  {"message":"hello world"}
• Nell'URL, utilizza l'indirizzo appspot.com e la chiave API effettivi anziché le variabili di ambiente. Ad esempio:
  https://example-project-12345.appspot.com/echo?key=AIza...

L'API restituisce il messaggio che invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta riuscita, consulta la sezione Risoluzione dei problemi relativi agli errori di risposta.

Hai eseguito il deployment e il test di un'API in Endpoints.

Nota: se vuoi farci sapere cosa ti è piaciuto di questo tutorial, non esitare a fornire un feedback in fondo a questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se si è verificato un errore, unisciti al gruppo Google google-cloud-endpoints e comunicaci cosa non ha funzionato. Questo gruppo riceve risposte da altri utenti di Endpoints e dagli ingegneri di Google, che lo monitorano.

monitora l'attività dell'API

1. Visualizza i grafici delle attività associate alla tua API nella pagina Endpoints.

   Vai alla pagina Servizi endpoint

   La visualizzazione dei dati relativi alla richiesta nei grafici può richiedere alcuni minuti.

2. Esamina i log delle richieste per la tua API nella pagina Esplora log.

   Vai alla pagina Esplora log

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

Consulta Eliminazione di un'API e delle istanze API per informazioni sull'interruzione dei servizi utilizzati in questo tutorial.

Passaggi successivi

• Condividere la tua API con un altro sviluppatore
• Scopri di più sull'autenticazione
• Scopri le opzioni di assistenza della community