Introduzione a 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 viene 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 la pagina Informazioni su Endpoints ed Architettura degli endpoint.

Obiettivi

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

  1. Configura un progetto Google Cloud, installa il software richiesto e crea un'app App Engine. Vedi Prima di iniziare.
  2. Scarica il codice campione. Vedi Ottenere il codice di esempio.
  3. Configura il file openapi-appengine.yaml, utilizzato per configurare gli endpoint. Consulta la pagina Configurazione di Endpoints.
  4. Eseguire il deployment della configurazione di Endpoints per creare un servizio Endpoints. Vedi Eseguire il deployment della configurazione di Endpoints.
  5. Eseguire il deployment dell'API e dell'ESP in App Engine. Vedi Deployment del backend dell'API.
  6. Invia una richiesta all'API. Vedi Invio di una richiesta all'API.
  7. Monitora l'attività dell'API. Consulta la sezione Attività dell'API di monitoraggio.
  8. Evita addebiti sul tuo account Google Cloud. Consulta Eseguire la pulizia.

Costi

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

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud possono essere idonei a una prova senza costi aggiuntivi.

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. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

  2. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  4. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  5. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

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

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

    • Utenti Linux e macOS: questo tutorial fornisce un esempio dell'utilizzo di curl, che in genere è preinstallato sul sistema operativo. Se non hai l'app curl, puoi scaricarla dalla pagina curl Release e download.
    • Utenti Windows: questo tutorial fornisce un esempio utilizzando Invoke-WebRequest, che è supportato in PowerShell 3.0 e versioni successive.
  8. Scarica Google Cloud CLI.
  9. Aggiorna gcloud CLI e installa i componenti di Endpoints. 
    gcloud components update
  10. Assicurati che Google Cloud CLI (gcloud) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud: 
    gcloud auth login
    Nella nuova scheda del browser che si apre, seleziona un account.
  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 gestirli, consulta Gestione delle configurazioni di gcloud CLI.

  12. Seleziona la regione in cui vuoi creare l'applicazione App Engine. Esegui questo comando per ottenere un elenco delle regioni: 
    gcloud app regions list
  13. Creare un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con l'ID progetto Google Cloud e YOUR_REGION con la regione in cui vuoi che venga creata 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 versioni successive, scaricala e installala.
  2. Clona il repository dell'app di esempio sulla tua macchina locale: 
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    In alternativa, scarica l'esempio 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 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 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 l'esempio 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 l'esempio 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 l'esempio 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, che si basa 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 la configurazione dell'autenticazione che non è necessaria per questo tutorial. Non è necessario configurare le righe con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
    • OpenAPI è una specifica indipendente dal linguaggio. Per praticità, lo stesso file openapi-appengine.yaml si trova nel campione getting-started in ogni repository GitHub di linguaggio.

  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 del documento OpenAPI richiesti da Endpoints, consulta la pagina Configurazione degli 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 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 Endpoint.

Durante la creazione e la configurazione del servizio, Service Management invia le informazioni al 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 Endpoint. L'ID configurazione del servizio è costituito da un timestamp della data seguito da un numero di revisione. Se esegui di nuovo il deployment del file openapi-appengine.yaml lo stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoint > Servizi della console Google Cloud.

Se viene visualizzato 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
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, 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 progetto Google Cloud esistente in cui questi servizi sono stati disabilitati esplicitamente.

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

gcloud services list

Se i servizi richiesti non sono elencati, abilitali:

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 Endpoint nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è mostrato sotto la colonna Nome servizio.

  • Per OpenAPI, il valore ENDPOINTS_SERVICE_NAME è quello 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 maggiori informazioni sui comandi gcloud, consulta la pagina relativa ai 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 per il backend dell'API. Questa sezione illustra il deployment dell'API e dell'ESP di esempio 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 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 l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specifichi questa opzione, fino a cinque minuti dopo il deployment di una nuova configurazione del servizio, ESP rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione anziché un ID di configurazione specifico per ESP.

  2. Salva il file app.yaml.

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

  3. Assicurati di essere nella directory endpoints/getting-started. Questa è la posizione del tuo file di configurazione openapi-appengine.yaml.
  4. Esegui questo comando per eseguire il deployment dell'API e dell'ESP di esempio in App Engine:

    5. Java

    Esegui il deployment con 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 dell'ambiente flessibile di App Engine.

Per maggiori informazioni, consulta la pagina relativa al deployment del backend dell'API.

invia richieste all'API

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

Crea una chiave API e imposta una variabile di ambiente

Il codice campione richiede una chiave API. Per semplificare la richiesta, imposti 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 Credenziali API. Se vuoi creare una chiave API in un altro progetto Google Cloud, consulta Abilitazione di un'API nel progetto Google Cloud.

    Vai alla pagina Credenziali

  2. Fai clic su Crea credenziali e 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'ID del tuo progetto Google Cloud:

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

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

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

Nei curl precedenti:

  • 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 progetto App Engine. Sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloud:

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

  2. Invia una richiesta HTTP utilizzando le variabili di ambiente ENDPOINTS_HOST e ENDPOINTS_KEY 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 l'accento grave. 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, ad esempio 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 un'eco al messaggio che lo invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta corretta, consulta la sezione Risoluzione degli errori di risposta.

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

monitora l'attività dell'API

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

    Vai alla pagina Endpoints Services

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

  2. Esamina 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 utilizzare il portale Cloud Endpoints per creare un portale per sviluppatori, un sito web che puoi utilizzare per interagire con l'API di esempio. Per ulteriori informazioni, consulta la pagina 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.

Per informazioni sull'interruzione dei servizi utilizzati da questo tutorial, vedi Eliminazione di un'API e istanze API.

Passaggi successivi