Iniziare a utilizzare Cloud Endpoints per GKE con ESP

---

OpenAPI   |  gRPC

Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy (ESP) in un cluster Google Kubernetes Engine (GKE).

L'API REST del codice campione è descritta utilizzando la specifica OpenAPI. Il tutorial mostra anche come creare una chiave API e utilizzarla per inviare richieste all'API.

Il tutorial utilizza immagini container precompilate del codice campione e dell'ESP, archiviate in Artifact Registry.

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à della Parte 1 sono necessarie per inviare correttamente le richieste all'API.

Parte 1

1. Configurare un progetto Google Cloud. Vedi Prima di iniziare.
2. Crea un cluster di contenitori su GKE. Consulta Creare un cluster di contenitori.
3. Installa e configura il software utilizzato nel tutorial. Consulta Installare e configurare il software necessario.
4. Scarica il codice campione. Consulta la sezione Recupero del codice di esempio.
5. Configura il file openapi.yaml, utilizzato per configurare Cloud Endpoints. Consulta Configurare Endpoints.
6. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Consulta Eseguire il deployment della configurazione di Endpoints.
7. Esegui il deployment dell'API e di ESP nel cluster. Consulta Eseguire il deployment del backend dell'API.
8. Ottieni l'indirizzo IP del cluster. Consulta Ottenere l'indirizzo IP esterno del cluster.
9. Invia una richiesta all'API utilizzando un indirizzo IP. Consulta Inviare una richiesta utilizzando un indirizzo IP.
10. Monitora l'attività dell'API. Consulta Monitorare l'attività dell'API.

Parte 2

1. Configura un record DNS per l'API di esempio. Consulta Configurare DNS per Endpoints.
2. Invia una richiesta all'API utilizzando il nome di dominio completo. Consulta Inviare una richiesta utilizzando l'FQDN.

Pulizia

Al termine, consulta la sezione Eseguire la pulizia per evitare che al tuo account Google Cloud vengano addebitati costi.

Costi

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

• GKE
• 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 Google Cloud, perché ti servirà in seguito.

Creazione di un cluster di container

Devi creare un cluster di container su GKE su cui eseguire il codice di backend dell'API di esempio.

Per creare un cluster di contenitori per l'API di esempio:

1. Nella console Google Cloud, vai alla pagina dei cluster GKE.
   

   Vai alla pagina dei cluster Kubernetes

2. Fai clic su Crea cluster.

3. Accetta le impostazioni predefinite e fai clic su Crea. Il completamento di questo passaggio può richiedere alcuni minuti.

4. Prendi nota del nome e della zona del cluster perché sono necessari per l'autenticazione kubectl al cluster di container.

Installazione e configurazione del software necessario

In questo tutorial, installi gcloud CLI per poter utilizzare Google Cloud CLI per gestire il tuo progetto. Utilizza kubectl per eseguire comandi sui cluster GKE. Inoltre, devi avere un modo per testare l'API.

Nella procedura che segue, se hai già installato il software richiesto, vai al passaggio successivo.

Per installare e configurare il software necessario:

1. 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 nel 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.
2. Installa e inizializza la gcloud CLI.
3. Aggiorna l'interfaccia a riga di comando gcloud e installa i componenti Endpoints:

   gcloud components update

4. 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.
5. 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 Gestire la gcloud CLI gcloud.

6. Installa kubectl:

   gcloud components install kubectl

7. Acquisisci nuove credenziali utente da utilizzare per le Credenziali predefinite dell'applicazione. Le credenziali utente sono necessarie per autorizzare kubectl.

   gcloud auth application-default login

   Nella nuova scheda del browser che si apre, seleziona un account.

Scarica il codice campione

Per aiutarti a iniziare rapidamente, il codice campione è fornito in diversi linguaggi.

Per scaricare il codice campione sulla tua macchina locale:

Java

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/java-docs-samples

   In alternativa, scarica l'esempio come file ZIP ed estrailo.

2. 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.yaml, che si basa sulla specifica OpenAPI 2.0.

Per configurare Endpoints:

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

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Vai

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Node.js

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Tieni presente quanto segue:

   • L'esempio di configurazione mostra le righe vicino al campo host che devi modificare. Per eseguire il deployment del file openapi.yaml in Endpoints, è necessario il documento OpenAPI completo.
   • Il file di esempio openapi.yaml contiene una sezione per la configurazione dell'autenticazione 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 comodità, lo stesso file openapi.yaml è presente nell'esempio getting-started in ogni repository GitHub per ogni lingua.

2. Nel campo host, sostituisci il testo con il nome del servizio Endpoints, che deve avere il seguente formato:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

   Sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloud. Ad esempio:

   host: "echo-api.endpoints.example-project-12345.cloud.goog"

Tieni presente che echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog è il nome del servizio Endpoints. Non è il nome di dominio completo (FQDN) che utilizzi per inviare richieste all'API.

Per informazioni sui campi nel documento OpenAPI richiesti da Endpoints, consulta Configurare Endpoints.

Dopo aver completato tutti i passaggi di configurazione che ti consentono di inviare correttamente richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione del DNS degli endpoint per informazioni su come configurare echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog come FQDN.

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.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.yaml. Service Management configura il servizio in base alle impostazioni nel file openapi.yaml. Quando apporti modifiche a openapi.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.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 [echo-api.endpoints.example-project-12345.cloud.goog]

Nell'esempio precedente, 2017-02-13r0 è l'ID configurazione del servizio e echo-api.endpoints.example-project-12345.cloud.goog è 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.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'attivazione 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 descrive la procedura per eseguire il deployment di container predefiniti per l'API di esempio e l'ESP nel cluster.

Controllo delle autorizzazioni richieste

ESP ed ESPv2 chiamano i servizi Google che utilizzano IAM per verificare se l'identità chiamante dispone di autorizzazioni sufficienti per accedere alle risorse IAM utilizzate. L'identità chiamante è l'account di servizio associato che esegue il deployment di ESP e ESPv2.

Quando viene eseguito il deployment in un pod GKE, l'account di servizio associato è l'account di servizio del nodo. Di solito si tratta dell'account di servizio predefinito di Compute Engine. Segui questo consiglio sulle autorizzazioni per scegliere un account di servizio del nodo appropriato.

Se viene utilizzato Workload Identity, è possibile utilizzare un account di servizio distinto dall'account di servizio del nodo per comunicare con i servizi Google. Puoi creare un account di servizio Kubernetes per il pod in cui eseguire ESP ed ESPv2, creare un account di servizio Google e associare l'account di servizio Kubernetes all'account di servizio Google.

Segui questi passaggi per associare un account di servizio Kubernetes a un account di servizio Google. Questo account di servizio Google è l'account di servizio associato.

Se l'account di servizio associato è il service account predefinito di Compute Engine del progetto e la configurazione del servizio di endpoint è dipiattata nello stesso progetto, l'account di servizio deve avere autorizzazioni sufficienti per accedere alle risorse IAM. Puoi saltare il passaggio di configurazione dei ruoli IAM. In caso contrario, i seguenti ruoli IAM devono essere aggiunti all'account di servizio associato.

Aggiungi i ruoli IAM richiesti:

Questa sezione descrive le risorse IAM utilizzate da ESP e ESPv2 e i ruoli IAM richiesti per l'accesso di questo account di servizio alle risorse.

Configurazione del servizio endpoint

ESP ed ESPv2 chiamano Service Control, che utilizza la configurazione del servizio endpoint. La configurazione del servizio endpoint è una risorsa IAM ed ESP ed ESPv2 richiedono il ruolo Responsabile controllo servizi per accedervi.

Il ruolo IAM si trova nella configurazione del servizio endpoint, non nel progetto. Un progetto può avere più configurazioni di servizi endpoint.

Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio associato per la configurazione del servizio endpoint.

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

Dove
* SERVICE_NAME è il nome del servizio endpoint
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio associato.

Cloud Trace

ESP ed ESPv2 chiamano il servizio Cloud Trace per esportare la traccia in un progetto. Questo progetto è chiamato progetto di monitoraggio. In ESP, il progetto di monitoraggio e il progetto proprietario della configurazione del servizio endpoint sono gli stessi. In ESPv2, il progetto di monitoraggio può essere specificato tramite il flag --tracing_project_id e per impostazione predefinita corrisponde al progetto di implementazione.

ESP ed ESPv2 richiedono il ruolo Agente Cloud Trace per abilitare Cloud Trace.

Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio collegato:

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

Dove
* TRACING_PROJECT_ID è l'ID progetto di monitoraggio
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio associato. Per ulteriori informazioni, consulta Che cosa sono i ruoli e le autorizzazioni?

Esegui il deployment dei container nel cluster

I container offrono un meccanismo di pacchettizzazione logico in cui puoi astrarre le applicazioni dall'ambiente in cui vengono effettivamente eseguite. Utilizza la procedura seguente per eseguire il deployment dell'API di esempio e dell'ESP nel cluster.

Per eseguire il deployment dei container nel cluster:

1. Recupera le credenziali del cluster e rendile disponibili per kubectl:

   gcloud container clusters get-credentials NAME 
   
       --zone ZONE

   Sostituisci NAME con il nome del cluster e ZONE con la zona del cluster.
2. Esegui il deployment di un servizio Kubernetes nel cluster GKE. Il servizio Kubernetes implementa l'API. Modifica il file di configurazione Kubernetes/endpoints/getting-started/deployment.yaml e sostituisci SERVICE_NAME nelle opzioni di avvio di ESP con il nome del servizio.
   Java

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Python

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Vai

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   PHP

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Ruby

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Node.js

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Ad esempio:

     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=echo-api.endpoints.example-project-12345.cloud.goog ",
       "--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. Per informazioni sulle altre opzioni ESP utilizzate, consulta Opzioni di avvio di ESP.

   Ti consigliamo di impostare imagePullPolicy nella spec del contenitore sopra riportata su Always. In questo modo, i pod appena creati potranno sempre recuperare l'ultima versione di ESP. Per saperne di più, consulta le best practice per la configurazione. Quando viene rilasciata una nuova versione di ESP, puoi eseguire un riavvio graduale di tutti i pod per assicurarti che venga utilizzata la versione più recente.

3. Avvia il servizio Kubernetes utilizzando il comando kubectl apply:

   kubectl apply -f deployment.yaml

Nota: se il tuo cluster GKE è privato, devi utilizzare il server dei metadati di Compute Engine come resolver DNS per risolvere i nomi host dei servizi Google. Aggiungi questo flag ESP: --dns=169.254.169.254

Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi relativi agli endpoint in GKE.

Per saperne di più, consulta Eseguire il deployment del backend dell'API.

Ottenere l'indirizzo IP esterno del cluster

Per inviare richieste all'API, devi disporre dell'IP esterno del servizio. Potrebbero essere necessari alcuni minuti dopo l'avvio del servizio nel contenitore prima che l'indirizzo IP esterno sia pronto.

1. Visualizza l'indirizzo IP esterno:

   kubectl get service
   

2. Prendi nota del valore di EXTERNAL-IP. Utilizza questo indirizzo IP quando invii una richiesta all'API di esempio.

Invio di una richiesta utilizzando un indirizzo IP

Ora che il servizio è in esecuzione nel cluster di container e disponi dell'indirizzo IP esterno, puoi inviare richieste all'API.

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

Utilizza curl per inviare una richiesta HTTP utilizzando la variabile di ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della tua istanza.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/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

Utilizza Invoke-WebRequest per inviare una richiesta HTTP utilizzando la variabile di ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della console.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/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 la chiave API effettiva anziché la variabile di ambiente. Ad esempio:
  http://192.0.2.0:80/echo?key=AIza...

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

{
  "message": "hello world"
}

Se non hai ricevuto una risposta positiva, consulta Risolvere i problemi relativi alle risposte.

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 inviare un feedback nella parte inferiore di questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se hai visualizzato un messaggio di errore, partecipa al gruppo Google google-cloud-endpoints e comunicaci cosa non ha funzionato. Questo gruppo riceve risposte da altri utenti di Endpoints e dai tecnici di Google, che lo monitorano.

monitora l'attività dell'API

Per monitorare l'attività dell'API:

1. Esamina i grafici delle attività della tua API nella pagina Endpoints > Servizi.
   

   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

Configurazione del DNS per Endpoints

Poiché il nome del servizio Endpoints per l'API si trova nel dominio .endpoints.YOUR_PROJECT_ID.cloud.goog, puoi usarlo come nome di dominio completo (FQDN) apportando una piccola modifica alla configurazione nel file openapi.yaml. In questo modo, puoi inviare richieste all'API di esempio utilizzando echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog instead of the IP address.

Per configurare il DNS di Endpoints:

1. Apri il file di configurazione OpenAPI openapi.yaml e aggiungi la proprietà x-google-endpoints al livello superiore del file (senza rientrare o nidificare) come mostrato nello snippet seguente:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"

2. Nella proprietà name, sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto.
3. Nella proprietà target, sostituisci IP_ADDRESS con l'indirizzo IP utilizzato quando hai inviato una richiesta all'API di esempio.
4. Esegui il deployment del file di configurazione OpenAPI aggiornato in Service Management:

   gcloud endpoints services deploy openapi.yaml
   

Ad esempio, supponiamo che nel file openapi.yaml sia configurato quanto segue:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Quando esegui il deployment del file openapi.yaml utilizzando il comando gcloud precedente, Service Management crea un record A DNS, echo-api.endpoints.my-project-id.cloud.goog, che risolve nell'indirizzo IP di destinazione 192.0.2.1. Potrebbero essere necessari alcuni minuti prima che la nuova configurazione DNS venga propagata.

Configurazione di SSL

Per ulteriori dettagli su come configurare DNS e SSL, consulta Attivare SSL per gli endpoint.

Invio di una richiesta utilizzando l'FQDN

Ora che hai configurato il record DNS per l'API di esempio, invia una richiesta utilizzando l'FQDN (sostitui YOUR_PROJECT_ID con il tuo ID progetto) e la variabile di ambiente ENDPOINTS_KEY impostata in precedenza:

• In Linux o macOS:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• In Windows PowerShell:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

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

• Scopri come creare un'immagine Docker.
• Scopri come eseguire il deployment di Endpoints su Kubernetes.
• Condividi la tua API con un altro sviluppatore.
• Scopri di più sull'autenticazione.
• Scopri le opzioni di assistenza della community.
• Risoluzione dei problemi di deployment GKE.