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

---

Questo tutorial mostra come configurare ed eseguire il deployment l'API di esempio e Extensible Service Proxy (ESP) in esecuzione su un'istanza Ambiente flessibile di App Engine. L'API REST del codice campione viene descritta utilizzando il comando Specifica OpenAPI. Il tutorial illustra anche come creare un chiave API e utilizzarla nelle richieste a l'API.

Per una panoramica di Cloud Endpoints, consulta Informazioni sugli endpoint e l'architettura degli endpoint.

Obiettivi

Durante il tutorial, utilizza il seguente elenco di attività di alto livello. Tutti per inviare correttamente le richieste all'API.

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

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

• App Engine
• Endpoints

Per generare una stima dei costi basata sull'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud potrebbero essere idonei per una prova gratuita.

Una volta completate le attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la pagina Pulizia.

Prima di iniziare

1. 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.

2. 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

3. Make sure that billing is enabled for your Google Cloud project.

4. 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

5. Make sure that billing is enabled for your Google Cloud project.

6. Prendi nota dell'ID progetto perché sarà necessario in seguito.

7. Devi disporre di un'applicazione per inviare richieste all'API di esempio.

   • Utenti Linux e macOS: questo tutorial fornisce un esempio dell'utilizzo curl, che in genere è preinstallata sul sistema operativo. Se non hai curl, puoi scaricarlo dal curl Pagina Release e download.
   • Utenti Windows: questo tutorial fornisce un esempio di utilizzo Invoke-WebRequest, ovvero supportato in PowerShell 3.0 e versioni successive.
8. Scarica Google Cloud CLI.
9. Aggiorna gcloud CLI e installa Endpoints componenti.

   gcloud components update

10. Assicurati che Google Cloud CLI (gcloud) sia autorizzato ad accedere i tuoi dati e servizi su Google Cloud:

    gcloud auth login

    Seleziona un account nella nuova scheda del browser che si apre.
11. Imposta il progetto predefinito sul tuo 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 gestirle, consulta Gestione della gcloud CLI gcloud.

12. Seleziona la regione in cui vuoi creare il tuo App Engine un'applicazione. Esegui questo comando per ottenere un elenco delle regioni:

    gcloud app regions list

13. Creare un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con il tuo Google Cloud con ID progetto e YOUR_REGION con la regione in cui creare l'applicazione App Engine.

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

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 una versione successiva, download e installalo.
2. Clona il repository dell'app di esempio nella tua macchina locale:

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

   In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

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 nella tua macchina locale:

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

   In alternativa, scarica l'esempio 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 il tuo La variabile di ambiente GOPATH è impostata.
2. Clona il repository dell'app di esempio nella 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 nella tua macchina locale:

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

   In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

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 nella tua macchina locale:

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

   In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

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 nella tua macchina locale:

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

   In alternativa, scarica l'anteprima come file ZIP ed estrarlo.

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, che si basa su Specifica OpenAPI v2.0.

Per configurare gli endpoint:

1. Nella directory codice campione, apri openapi-appengine.yaml di configurazione del deployment.
   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 linee vicino a host , che dovrai modificare. Per eseguire il deployment di openapi-appengine.yaml a Endpoints, è necessario il documento OpenAPI completo.
   • L'esempio openapi-appengine.yaml contiene una sezione per configurare l'autenticazione non necessaria per questo tutorial. Non devi configurare le linee con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
   • OpenAPI è una specifica indipendente dalla lingua. Uguale openapi-appengine.yaml file è nel getting-started campione in repository GitHub di ogni linguaggio.

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

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

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

Per informazioni sui campi nel documento OpenAPI che Per gli endpoint è necessario, consulta Configurazione Endpoint.

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 essere 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 Service Management API per creare un servizio gestito con il nome specificato Campo host del file openapi-appengine.yaml. Service Management configura il servizio in base al impostazioni nel file openapi-appengine.yaml. Quando apporti modifiche openapi-appengine.yaml, devi rieseguire il deployment del file per aggiornare Servizio Endpoints.

Durante la creazione e la configurazione del servizio, Service Management invia informazioni al terminale. Puoi ignorare tranquillamente gli avvisi su I percorsi nel file openapi-appengine.yaml non richiedono una chiave API. Al termine della configurazione del servizio, Service Management visualizza con l'ID configurazione del servizio e il nome del servizio, simili seguenti:

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

Nell'esempio precedente, 2017-02-13r0 è il servizio dell'ID configurazione, mentre example-project-12345.appspot.com è Servizio Endpoints. L'ID configurazione del servizio è costituito da un data e ora seguita da un numero di revisione. Se esegui di nuovo il deployment del file openapi-appengine.yaml nello stesso giorno, il numero della revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints negli Endpoint > la pagina Servizi nella console Google Cloud.

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

Controllo dei servizi richiesti in corso...

Come minimo, Endpoints ed ESP richiedono seguenti servizi Google da attivare:

Nome	Titolo
servicemanagement.googleapis.com	API Service Management
servicecontrol.googleapis.com	API Service Control
endpoints.googleapis.com	Google Cloud Endpoints

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

• Se hai utilizzato un'applicazione di terze parti, come Terraform, includono questi servizi.

• Hai eseguito il deployment della configurazione di Endpoints in una Progetto Google Cloud in cui questi servizi sono stati disattivati esplicitamente.

Utilizza il comando seguente per confermare che i servizi richiesti siano abilitati:

gcloud services list

Se non vedi i servizi richiesti nell'elenco, attivali:

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

Abilita anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare 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 è visualizzato nella colonna Nome servizio.

• Per OpenAPI, ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo host della specifica OpenAPI. Per gRPC, il valore ENDPOINTS_SERVICE_NAME è quello specificato nel campo name della configurazione degli endpoint gRPC.

Per ulteriori informazioni 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. Questo 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 tuo 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 servizio Endpoints. Si tratta dello stesso nome configurato nel host campo del documento OpenAPI. Ad esempio:

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

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

2. Salva il file app.yaml.

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

3. Assicurati di essere nella directory endpoints/getting-started. È qui che si trova il file di configurazione di openapi-appengine.yaml individuarlo.
4. Esegui questo comando per eseguire il deployment dell'API e dell'ESP di esempio 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 qualche minuto prima di inviare richieste all'API durante l'inizializzazione completa di App Engine.

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di deployment nell'ambiente flessibile di App Engine.

Per ulteriori informazioni, vedi Deployment del backend dell'API.

invia richieste all'API

Ora che il servizio è in esecuzione su App Engine, puoi inviare richieste li annotino.

crea una chiave API e imposta una variabile di ambiente

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

1. Nello stesso progetto Google Cloud che hai utilizzato per l'API, crea una chiave API nella Credenziali API. Se vuoi creare una chiave API in un altro progetto Google Cloud, vedi Abilitare un'API nel progetto Google Cloud.

   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. Incolla la chiave API sul computer locale per assegnarla a un ambiente variabile:
   • 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 tuo progetto App Engine. Sostituisci YOUR_PROJECT_ID con ID progetto Google Cloud:

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

2. Invia una richiesta HTTP utilizzando ENDPOINTS_HOST e ENDPOINTS_KEY variabili di ambiente impostate in precedenza:

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

Nel periodo precedente (curl):

• L'opzione --data consente di specificare 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 tuo progetto App Engine. Sostituisci YOUR_PROJECT_ID con ID progetto Google Cloud:

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

2. Invia una richiesta HTTP utilizzando ENDPOINTS_HOST e ENDPOINTS_KEY variabili di ambiente impostate 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 i backtick. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, vedi Invoke-WebRequest nel documentazione.

App di terze parti

Puoi utilizzare un'applicazione di terze parti come il browser Chrome Postman per inviare 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 il valore effettivo per appspot.com e la chiave API anziché le variabili di ambiente. Ad esempio:
  https://example-project-12345.appspot.com/echo?key=AIza...

L'API restituisce il messaggio che le hai inviato e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta positiva, consulta Risoluzione degli errori di risposta.

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

Nota: se vuoi farci sapere cosa ti è piaciuto di questa presentazione tutorial, non esitare a fornire un feedback in fondo a questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se ricevi un messaggio di errore, partecipa al google-cloud-endpoints gruppo Google e facci sapere cosa non ha funzionato. Questo gruppo riceve risposte da altri Utenti di Endpoints e degli ingegneri Google che monitorano il gruppo.

monitora l'attività dell'API

1. Visualizza i grafici delle attività per l'API nella pagina Endpoint.

   Vai alla pagina dei servizi Endpoints

   Potrebbero essere necessari alcuni minuti prima che la richiesta venga riportata nei grafici.

2. Controlla i log delle richieste per l'API nella pagina Esplora log.

   Vai alla pagina Esplora log

Creazione di un portale per gli sviluppatori per l'API

Puoi usare il portale Cloud Endpoints per creare un portale per sviluppatori, un sito web che puoi utilizzare per interagire con l'API di esempio. Per saperne di più, consulta la panoramica del portale Cloud Endpoints.

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 l'articolo sull'eliminazione di un'API e di istanze API per informazioni sull'interruzione dei servizi utilizzati da questo tutorial.

Passaggi successivi

• Condividere l'API con un altro sviluppatore
• Scopri di più sull'autenticazione
• Scopri di più sulle opzioni di assistenza dalla community