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 del proxy di servizio Extensible (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

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

  1. Configura un progetto Google Cloud, installa il software necessario e crea un'app App Engine. Consulta 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 un servizio Endpoints. Consulta Eseguire il 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. Consulta Pulizia.

Costi

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

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.

Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione 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.

    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.

    Go to project selector

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

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

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

    • 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 Release e download.
    • Utenti Windows: questo tutorial fornisce un esempio di utilizzo di Invoke-WebRequest, 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 utilizzarli con gcloud per gestirli, consulta Gestione della gcloud CLI gcloud.

  12. Seleziona la regione in cui vuoi creare l'applicazione App Engine. Esegui il comando seguente per ottenere un elenco di regioni: 
    gcloud app regions list
  13. Crea un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con l'ID del progetto Google Cloud e YOUR_REGION con la regione in cui vuoi 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 versioni successive, scarica 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 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
Node.js

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, basato sulla specifica OpenAPI 2.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"
    Node.js
    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 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 è presente nell'esempio getting-started di ogni repository GitHub per la 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 di 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, consulta Configurare 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 Gestione servizi 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 Endpoints.

Durante la creazione e la configurazione del servizio, Service Management visualizza informazioni nel terminale. Puoi ignorare tranquillamente gli avvisi relativi ai 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 configurazione del servizio e example-project-12345.appspot.com è il servizio Endpoints. L'ID configurazione del servizio è costituito da un timbro di data seguito 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 nella pagina Endpoints > Servizi della console Google Cloud.

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

Verifica 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 obbligatori. Tuttavia, il comando gcloud viene completato correttamente, ma non attiva 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 disattivati esplicitamente.

Utilizza il seguente comando per verificare 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

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 è riportato nella colonna Nome servizio.

  • Per OpenAPI, ENDPOINTS_SERVICE_NAME è il valore specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è il valore 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

Fino a questo punto, hai eseguito il deployment del documento OpenAPI in Service Management, ma non hai ancora eseguito il deployment del codice soggiacente al 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

    Node.js

    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

    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 aver eseguito 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.

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

  3. Assicurati di essere nella directory endpoints/getting-started. Qui si trova il file di configurazione openapi-appengine.yaml.
  4. Esegui il comando seguente per eseguire il deployment dell'API di esempio e dell'ESP in App Engine:

    5. 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 viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di deployment in ambienti flessibili di App Engine.

Per ulteriori informazioni, consulta Eseguire il 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 utilizzato per l'API, crea una chiave API nella pagina delle 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 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 il tuo ID 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}"

Nel 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 il tuo ID 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 backtick. 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, 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 effettivo 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 la sezione Risoluzione dei problemi relativi alle risposte.

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

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

Creazione di un portale per gli sviluppatori per l'API

Puoi utilizzare il portale Cloud Endpoints per creare un portale per gli 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 la sezione Eliminare un'API e le relative istanze per informazioni su come interrompere i servizi utilizzati da questo tutorial.

Passaggi successivi