Introduzione a Cloud Endpoints per GKE con ESP

---

OpenAPI   | gRPC

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

L'API REST del codice campione è descritta usando la specifica OpenAPI. La il tutorial illustra anche come creare un'API chiave e utilizzarla per l'invio di richieste all'API.

Il tutorial utilizza immagini container predefinite del codice campione ESP, che vengono archiviati in Container Registry.

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

Parte 1

1. Configurare un progetto Google Cloud. Vedi Prima di iniziare.
2. Creare un cluster di container su GKE. Consulta Creazione di un cluster container.
3. Installa e configura il software utilizzato nel tutorial. Vedi Installare e configurare il software richiesto.
4. Scarica il codice campione. Consulta Recupero del codice di esempio.
5. Configura il file openapi.yaml, utilizzato per configurare Cloud Endpoints. Consulta Configurazione di Endpoints.
6. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Consulta Deployment della configurazione di Endpoints.
7. Eseguire il deployment di API ed ESP nel cluster. Consulta 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. Vedi Invio di una richiesta utilizzando un indirizzo IP.
10. Monitorare l'attività dell'API. Consulta Monitoraggio dell'attività dell'API.

Parte 2

1. Configura un record DNS per l'API di esempio. Consulta Configurazione del DNS per Endpoints.
2. Invia una richiesta all'API utilizzando il nome di dominio completo. Vedi Invio di una richiesta tramite FQDN.

Pulizia

Al termine, consulta Pulizia per evitare addebiti. al tuo account Google Cloud.

Costi

In questo documento vengono utilizzati 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. 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. 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. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

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. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

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

Creazione di un cluster di container

Devi creare un cluster di container su GKE per l'esempio Codice backend API su cui eseguire.

Per creare un cluster di container 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 del cluster e della zona perché sono necessari durante l'autenticazione kubectl al cluster di container.

Installazione e configurazione del software richiesto

In questo tutorial installerai gcloud CLI in modo da poter utilizzare Google Cloud CLI per gestire il tuo progetto. Usa kubectl per eseguire comandi su GKE cluster. Devi anche trovare un modo per testare l'API.

Nella procedura seguente, se disponi già dei necessari installato, continua con il passaggio successivo.

Per installare e configurare il software richiesto:

1. È necessaria un'applicazione per inviare richieste l'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.
2. Installa e inizializza gcloud CLI.
3. Aggiorna gcloud CLI e installa i componenti Endpoints:

   gcloud components update

4. 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.
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 utilizzare gcloud consulta Gestione di gcloud CLI configurazioni.

6. Installa kubectl:

   gcloud components install kubectl

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

   gcloud auth application-default login

   Seleziona un account nella nuova scheda del browser che si apre.

Download del codice campione

Per aiutarti a iniziare subito a lavorare, il codice campione viene fornito in diverse lingue diverse.

Per scaricare il codice campione sul tuo computer locale:

Java

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

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

2. Passa alla directory che contiene il codice campione:

   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'anteprima come file ZIP ed estrarlo.

2. Passa alla directory che contiene il codice campione:

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

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

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

.

.

Rosso rubino

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

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

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

Configurazione di Endpoints

Il codice campione include il file di configurazione OpenAPI openapi.yaml, che è basato su Specifica OpenAPI v2.0.

Per configurare gli endpoint:

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"

   Rosso rubino

   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"

   NodeJS

   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 linee vicino a host , che dovrai modificare. Per eseguire il deployment del file openapi.yaml a Endpoints, è necessario il documento OpenAPI completo.
   • Il file openapi.yaml di esempio contiene una sezione per la configurazione non necessaria per questo tutorial. Non è necessario configurare le linee con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
   • OpenAPI è una specifica indipendente dalla lingua. Lo stesso file openapi.yaml si trova nell'esempio getting-started in GitHub di ogni lingua repository per praticità.

2. Nel campo host, sostituisci il testo con Nome 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 si tratta del modello completo nome di dominio (FQDN) che utilizzi per inviare richieste all'API.

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

Dopo aver completato tutti i seguenti passaggi di configurazione per inviare richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione del DNS di Endpoints per informazioni su come per 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 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.yaml
   

Il comando gcloud chiama quindi Service Management API per creare un servizio gestito con il nome specificato Campo host del file openapi.yaml. Service Management configura il servizio in base al impostazioni nel file openapi.yaml. Quando apporti modifiche openapi.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.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 [echo-api.endpoints.example-project-12345.cloud.goog]

Nell'esempio precedente, 2017-02-13r0 è il servizio dell'ID configurazione, mentre echo-api.endpoints.example-project-12345.cloud.goog è Servizio Endpoints. L'ID configurazione del servizio è costituito da un data e ora seguita da un numero di revisione. Se esegui il deployment Di nuovo openapi.yaml file nello stesso giorno, la 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 ricevi 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 elencati i servizi richiesti, 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 il 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 è 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 gcloud servizi.

esegui il deployment del backend dell'API

Finora hai eseguito il deployment del documento OpenAPI in Service Management, ma non hai ancora eseguito il deployment del codice che gestisce il backend dell'API. Questa sezione illustra come eseguire il deployment di container predefiniti per l'API di esempio ESP nel cluster.

Controllo delle autorizzazioni richieste in corso...

ESP ed ESPv2 chiama i servizi Google che utilizzano IAM per: verifica che l'identità chiamante disponga di autorizzazioni sufficienti per accedere alla risorsa IAM utilizzata Google Cloud. L'identità chiamante è l'account di servizio collegato che esegue il deployment di ESP ed ESPv2.

Dopo il deployment nel pod GKE, l'account di servizio collegato è il servizio nodo . Di solito è l'account di servizio predefinito di Compute Engine. Segui queste istruzioni suggerimento di autorizzazione per scegliere un account di servizio del nodo appropriato.

Se Workload Identity è un account di servizio separato e diverso dal nodo l'account di servizio può essere usato per comunicare con i servizi Google. Puoi creare un Account di servizio Kubernetes per il pod per l'esecuzione di ESP ESPv2, creare un account di servizio Google e associare il cluster Kubernetes di servizio all'account di servizio Google.

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

Se l'account di servizio collegato è Computing Account di servizio predefinito del motore del progetto e del servizio endpoint di configurazione del deployment nello stesso progetto, l'account di servizio deve disporre di autorizzazioni sufficienti per accedere alle risorse IAM, seguendo la configurazione dei ruoli IAM è possibile saltare questo passaggio. In caso contrario, devi aggiungere i seguenti ruoli IAM con un account di servizio collegato.

Aggiungi i ruoli IAM richiesti:

Questa sezione descrive le risorse IAM utilizzate da ESP e ESPv2 e i ruoli IAM richiesti per l'account di servizio collegato per accedere a queste 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, mentre ESP ed ESPv2 necessitano Controller di 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 al servizio collegato 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 collegato.

Cloud Trace

Chiamata ESP ed ESPv2 Cloud Trace per esportare Trace in un progetto. Questo progetto è chiamato tracciamento progetto. In ESP, il progetto di tracciamento e il progetto proprietario la configurazione del servizio endpoint è la stessa. In ESPv2, il progetto di tracciamento può essere specificato dal flag --tracing_project_id, e il valore predefinito del progetto di deployment.

ESP ed ESPv2 richiedono l'agente Cloud Trace per abilitare Cloud Trace.

Utilizza il seguente comando gcloud per aggiungere il ruolo al 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 del progetto di tracciamento
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com è l'account di servizio collegato. Per ulteriori informazioni, vedi Cosa sono i ruoli e le autorizzazioni?

Deployment dei container nel cluster

I container offrono un meccanismo di pacchettizzazione logico in cui è possibile applicazioni astratte dall'ambiente in cui vengono eseguite. Usa la seguente procedura per eseguire il deployment dell'API e dell'ESP di esempio nel cluster.

Per eseguire il deployment dei container nel cluster:

1. Ottieni le credenziali del cluster e rendile disponibili a kubectl:

   gcloud container clusters get-credentials NAME 
   
       --zone ZONE

   Sostituisci NAME con il nome del cluster e ZONE con la zona del cluster.
2. Eseguire il deployment di un servizio Kubernetes nel cluster GKE. La Il servizio Kubernetes implementa l'API. Modifica il file di configurazione di Kubernetes /endpoints/getting-started/deployment.yaml, e sostituisci SERVICE_NAME nell'ESP con il nome del tuo 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",
     ]

   Rosso rubino

   - 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",
     ]

   NodeJS

   - 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",
     ]
   

   Opzione --rollout_strategy=managed configura ESP in modo che utilizzi l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specificare questa opzione, fino a 5 minuti dopo il deployment di un nuovo servizio configurazione, ESP rileva la modifica e inizia automaticamente a utilizzarla. Me consigliamo di specificare questa opzione anziché un ID configurazione specifico per ESP. Per informazioni sulle altre opzioni ESP utilizzate, vedi Opzioni di avvio di ESP.

   Ti consigliamo di impostare imagePullPolicy in la specifica del container precedente a Always. Ciò consentirà ai pod appena creati di eseguire sempre il pull della versione più recente di ESP. Informazioni su per la configurazione. Quando viene rilasciata una nuova versione di ESP, puoi eseguire una il riavvio in sequenza di tutti i pod per garantire 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 di metadati di Compute Engine come il resolver DNS per risolvere i nomi host dei servizi Google. Aggiungi questo flag ESP: --dns=169.254.169.254

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di Endpoints in GKE.

Consulta Deployment del backend dell'API per ulteriori informazioni.

recupera l'indirizzo IP esterno del cluster

Per inviare richieste all'API, devi avere l'IP esterno del servizio. Può richiede alcuni minuti dall'avvio del servizio nel container prima l'indirizzo IP esterno è pronto.

1. Visualizza l'indirizzo IP esterno:

   kubectl get service
   

2. Prendi nota del valore di EXTERNAL-IP. Questo indirizzo IP viene utilizzato invia una richiesta all'API di esempio.

Invio di una richiesta tramite un indirizzo IP

Ora che il servizio è in esecuzione nel cluster di container e che hai un 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, 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 Attivazione 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. 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

Utilizza curl per inviare una richiesta HTTP tramite l'ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno dell'istanza.

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

Usa Invoke-WebRequest per inviare una richiesta HTTP mediante ENDPOINTS_KEY che hai impostato in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno del tuo in esecuzione in un'istanza Compute Engine.

(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 accento grave. Quando incolli in PowerShell, assicuratevi che non ci sia uno spazio dopo l’accento grave. 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 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 seguenti:

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

Per monitorare l'attività dell'API:

1. Osserva i grafici delle attività per l'API nella Endpoint > Servizi.
   

   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

Configurazione del DNS per Endpoints

Poiché il nome del servizio Endpoints per l'API è in .endpoints.YOUR_PROJECT_ID.cloud.goog dominio, puoi come nome di dominio completo (FQDN) inserendo un piccolo modifica alla configurazione nel file openapi.yaml. In questo modo puoi invia richieste all'API di esempio utilizzando echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog anziché l'indirizzo IP.

Per configurare il DNS di Endpoints:

1. Apri il file di configurazione OpenAPI, openapi.yaml, e aggiungi Proprietà x-google-endpoints al livello superiore del file (non rientrato o nidificato) come mostrato nel seguente snippet:

   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 il tuo ID progetto.
3. Nella proprietà target, sostituisci IP_ADDRESS con L'indirizzo IP che hai 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 il file openapi.yaml abbia quanto segue configurato:

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 metodo gcloud, Service Management crea un record A DNS, echo-api.endpoints.my-project-id.cloud.goog, che si risolve nel indirizzo IP di destinazione, 192.0.2.1. Potrebbero essere necessari alcuni minuti nuova configurazione DNS da propagare.

Configurazione di SSL

Per maggiori dettagli su come configurare DNS e SSL, consulta Attivazione di SSL per Endpoint.

Invio di una richiesta tramite FQDN

Ora che hai configurato il record DNS per l'API di esempio, invia un utilizzando il nome di dominio completo (sostituisci YOUR_PROJECT_ID con l'ID progetto) e la variabile di ambiente ENDPOINTS_KEY impostata in precedenza:

.
• In Linux o Mac OS:

  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 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ù, vedi 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

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