Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy V2 (ESPv2) in esecuzione in container Docker predefiniti su Compute Engine.
L'API REST del codice campione viene descritta utilizzando la specifica OpenAPI. Il tutorial mostra inoltre 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.- Configurare un progetto Google Cloud. Consulta Prima di iniziare.
- Creare un'istanza VM di Compute Engine. Vedi Creazione di un'istanza Compute Engine.
- Scarica il codice campione. Vedi Ottenere il codice di esempio.
- Configura il file
openapi.yaml
, utilizzato per configurare gli endpoint. Consulta la pagina Configurazione di Endpoints. - Eseguire il deployment della configurazione di Endpoints per creare un servizio endpoint. Vedi Eseguire il deployment della configurazione di Endpoints.
- Eseguire il deployment dell'API ed ESPv2 sulla VM di Compute Engine. Vedi Deployment del backend dell'API.
- Invia una richiesta all'API utilizzando un indirizzo IP. Vedi Inviare una richiesta tramite l'indirizzo IP.
- Configura un record DNS per l'API di esempio. Vedi Configurazione del DNS per Endpoints.
- Invia una richiesta all'API utilizzando il nome di dominio completo. Vedi Inviare una richiesta utilizzando il nome di dominio completo.
- Monitora l'attività dell'API. Consulta la sezione Attività dell'API di monitoraggio.
- 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 basata sull'utilizzo previsto,
utilizza il Calcolatore prezzi.
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
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
- Prendi nota dell'ID progetto perché sarà necessario in seguito.
-
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'appcurl
, puoi scaricarla dalla paginacurl
Release e download. - Utenti Windows: questo tutorial fornisce un esempio utilizzando
Invoke-WebRequest
, che è supportato in PowerShell 3.0 e versioni successive.
- Utenti Linux e macOS: questo tutorial fornisce un esempio dell'utilizzo di
- Scarica Google Cloud CLI.
-
Aggiorna gcloud CLI e installa i componenti di Endpoints.
gcloud components update
-
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. -
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.
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.
Creazione di un'istanza Compute Engine
- In the Google Cloud console, go to the Create an instance page.
- Nella sezione Firewall, seleziona Consenti traffico HTTP e Consenti traffico HTTPS.
- Per creare la VM, fai clic su Crea.
- Assicurati di poterti connettere alla tua istanza VM.
- Nell'elenco delle istanze di macchine virtuali, fai clic su SSH nella riga dell'istanza a cui vuoi connetterti.
- Ora puoi utilizzare il terminale per eseguire i comandi Linux sulla tua istanza Debian.
- Inserisci
exit
per disconnetterti dall'istanza.
- Prendi nota del nome dell'istanza, della zona e dell'indirizzo IP esterno perché saranno necessari in seguito.
Per creare un'istanza Compute Engine:
Potrebbe essere necessario un po' di tempo per l'avvio dell'istanza. Quando è pronta, viene elencata nella pagina Istanze VM con un'icona di stato verde.
Download del codice campione in corso...
Scarica il codice campione sulla tua macchina locale.
Per clonare o scaricare l'API di esempio:
- 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.
- Passa alla directory che contiene il codice di esempio:
cd java-docs-samples/endpoints/getting-started
Per clonare o scaricare l'API di esempio:
- 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.
- Passa alla directory che contiene il codice di esempio:
cd python-docs-samples/endpoints/getting-started
Per clonare o scaricare l'API di esempio:
- Assicurati che la
variabile di ambiente
GOPATH
sia impostata. - Clona il repository dell'app di esempio sulla tua macchina locale:
go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
- Passa alla directory che contiene il codice di esempio:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
Per clonare o scaricare l'API di esempio:
- 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.
- Passa alla directory che contiene il codice di esempio:
cd php-docs-samples/endpoints/getting-started
Per clonare o scaricare l'API di esempio:
- 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.
- Passa alla directory che contiene il codice di esempio:
cd ruby-docs-samples/endpoints/getting-started
Per clonare o scaricare l'API di esempio:
- 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.
- 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 v2.0.
Puoi configurare ed eseguire il deployment di openapi.yaml
sulla tua macchina locale.
Per configurare Endpoints:
- Nella directory codice campione, apri il file di configurazione
openapi.yaml
.Java Python Vai PHP Ruby NodeJS Tieni presente quanto segue:
- L'esempio di configurazione mostra le righe vicino al campo
host
, che devi modificare. Per eseguire il deployment del fileopenapi.yaml
in Endpoints, è necessario il documento OpenAPI completo. - Il file
openapi.yaml
di esempio 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.yaml
si trova nell'esempiogetting-started
in ogni repository GitHub di linguaggio.
- L'esempio di configurazione mostra le righe vicino al campo
- Nel campo
host
, sostituisci il testo con il nome del servizio endpoint, che deve essere nel 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 le richieste all'API.
Per informazioni sui campi del documento OpenAPI richiesti da Endpoints, consulta Configurazione degli endpoint.
Dopo aver completato tutti i passaggi di configurazione seguenti per poter inviare correttamente le richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione del DNS di Endpoints per informazioni su come configurare echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
come nome di dominio completo.
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:
- Assicurati di essere nella directory
endpoints/getting-started
. - 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 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.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 di configurazione del servizio e echo-api.endpoints.example-project-12345.cloud.goog
è 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.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.comgcloud 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 camponame
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 utilizzato per il backend dell'API. Questa sezione illustra come configurare Docker sulla tua istanza VM e come eseguire il codice di backend dell'API e ESPv2 in un container Docker.
Controllo delle autorizzazioni richieste in corso...
- Nella console Google Cloud, vai alla pagina Istanze Compute Engine.
- Seleziona la tua istanza dall'elenco.
- Puoi visualizzare l'account di servizio associato e le autorizzazioni che dispone.
Concedi le autorizzazioni richieste all'account di servizio:
gcloud projects add-iam-policy-binding PROJECT_NAME \ --member "serviceAccount:SERVICE_ACCOUNT" \ --role roles/servicemanagement.serviceController
Per ulteriori informazioni, vedi Cosa sono i ruoli e le autorizzazioni?
Installa Docker sull'istanza VM
Per installare Docker sull'istanza VM:
- Imposta la zona per il tuo progetto eseguendo il comando:
gcloud config set compute/zone YOUR_INSTANCE_ZONE
Sostituisci YOUR_INSTANCE_ZONE con la zona in cui è in esecuzione l'istanza.
- Connettiti all'istanza utilizzando il seguente comando:
gcloud compute ssh INSTANCE_NAME
Sostituisci INSTANCE_NAME con il nome dell'istanza VM.
- Consulta la documentazione di Docker per configurare il repository Docker. Assicurati di seguire i passaggi corrispondenti alla versione e all'architettura della tua istanza VM:
- Jessie o più recenti
- x86_64 / amd64
esegui l'API ed ESPv2 in un container Docker
ESPv2 è un proxy basato su Envoy
che si trova davanti al codice di backend. Elabora il traffico in entrata per fornire l'autenticazione, la gestione delle chiavi API, il logging e altre funzionalità di gestione dell'API Endpoints.
Per installare ed eseguire l'API di esempio e ESPv2 in un container Docker:
- Crea la tua rete di container denominata
esp_net
.sudo docker network create --driver bridge esp_net
- Esegui il server Echo di esempio che gestisce l'API di esempio:
Java sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-java:1.0
Python sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-python:1.0
Vai sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-go:1.0
PHP sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-php:1.0
Ruby sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-ruby:1.0
NodeJS sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-node:1.0
- Esegui il container Docker ESPv2 pubblico preconfezionato.
Nelle opzioni di avvio di ESPv2, sostituisci SERVICE_NAME con il nome del tuo servizio. Si tratta dello stesso nome che hai configurato nel campo
host
del documento OpenAPI.sudo docker run \ --detach \ --name=esp \ --publish=80:9000 \ --net=esp_net \ gcr.io/endpoints-release/endpoints-runtime:2 \ --service=SERVICE_NAME \ --rollout_strategy=managed \ --listener_port=9000 \ --backend=http://echo:8080
L'opzione
--rollout_strategy=managed
configura ESPv2 in modo che utilizzi l'ultima configurazione del servizio di cui è stato eseguito il deployment. Quando specifichi questa opzione, entro un minuto dopo il deployment di una nuova configurazione del servizio, ESPv2 rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione anziché fornire un ID configurazione specifico per ESPv2. Per informazioni sulle altre opzioni di ESPv2 utilizzate in precedenza, consulta Opzioni di avvio di ESPv2.
Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di Endpoints su Compute Engine. Per ulteriori informazioni, consulta Deployment del backend dell'API.
Invio di una richiesta tramite un indirizzo IP
Quando l'API di esempio ed ESPv2 sono in esecuzione sull'istanza di Compute Engine, puoi inviare richieste all'API dalla tua macchina locale.
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.
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.
- Fai clic su Crea credenziali e seleziona Chiave API.
- Copia la chiave negli appunti.
- Fai clic su Chiudi.
- 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..."
- In Linux o macOS:
Invia la richiesta
Linux o Mac OS
Utilizza curl
per inviare una richiesta HTTP mediante 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}"
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
Utilizza Invoke-WebRequest
per inviare una richiesta HTTP mediante la variabile di ambiente ENDPOINTS_KEY
impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno dell'istanza.
(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 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 valoreapplication/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 l'eco al messaggio che 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.
Configurazione del DNS per gli endpoint
Poiché il nome di servizio Endpoints per l'API si trova nel dominio .endpoints.YOUR_PROJECT_ID.cloud.goog
, puoi utilizzarlo 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
anziché l'indirizzo IP.
Per configurare il DNS di Endpoints:
- Apri il file di configurazione OpenAPI
openapi.yaml
e aggiungi la proprietàx-google-endpoints
al livello principale 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"
- Nella proprietà
name
, sostituisci YOUR_PROJECT_ID con il tuo ID progetto. - Nella proprietà
target
, sostituisci IP_ADDRESS con l'indirizzo IP che hai utilizzato quando hai inviato una richiesta all'API di esempio. - Esegui il deployment del file di configurazione OpenAPI aggiornato in Service Management:
gcloud endpoints services deploy openapi.yaml
Ad esempio, supponiamo che per il 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 si risolve nell'indirizzo IP di destinazione, 192.0.2.1
. La propagazione della nuova configurazione DNS potrebbe richiedere alcuni minuti.
Configurazione di SSL
Per maggiori dettagli su come configurare DNS e SSL, consulta Abilitazione di SSL per gli endpoint.
Invio di una richiesta tramite nome di dominio completo
Ora che hai configurato il record DNS per l'API di esempio, invia all'API di esempio una richiesta utilizzando il nome di dominio completo (sostituisci YOUR_PROJECT_ID con il tuo 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
monitora l'attività dell'API
Per monitorare l'attività dell'API:
- Guarda i grafici di attività per la tua API nella pagina Endpoint > Servizi.
Vai alla pagina Endpoints Services
Potrebbero essere necessari alcuni minuti prima che la richiesta venga riportata nei grafici. - Esamina i log delle richieste per l'API nella 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.
- Elimina l'API:
gcloud endpoints services delete SERVICE_NAME
Sostituisci
SERVICE_NAME
con il nome del tuo servizio. - Nella console Google Cloud, vai alla pagina Istanze VM.
- Seleziona la casella di controllo per l'istanza che vuoi eliminare.
- Per eliminare l'istanza, fai clic su Altre azioni, quindi su Elimina e segui le istruzioni.