Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy V2 (ESPv2) in container Docker predefiniti su Compute 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 sugli endpoint e l'architettura degli endpoint.
Obiettivi
Segui il seguente elenco di attività di alto livello durante il tutorial. Tutti per inviare correttamente le richieste all'API.- Configurare un progetto Google Cloud. Consulta: Prima di iniziare.
- Creare un'istanza VM di Compute Engine. Consulta: Creazione di un'istanza Compute Engine.
- Scarica il codice campione. Consulta la sezione Recupero del codice di esempio.
- Configura il file
openapi.yaml
, utilizzato per configurare Endpoints. Consulta: Configurazione di Endpoints. - Esegui il deployment della configurazione di Endpoints per creare Servizio Endpoints. Consulta Eseguire il deployment della configurazione di Endpoints.
- Esegui il deployment dell'API e di ESPv2 sulla VM Compute Engine. Consulta Esegui il deployment del backend dell'API.
- Invia una richiesta all'API utilizzando un indirizzo IP. Consulta Invio di una richiesta utilizzando l'indirizzo IP.
- Configura un record DNS per l'API di esempio. Consulta: Configurazione del DNS per Endpoints.
- Invia una richiesta all'API utilizzando il nome di dominio completo. Consulta: Invio di una richiesta tramite FQDN.
- Monitorare l'attività dell'API. Consulta Monitoraggio dell'attività dell'API.
- Evita che al tuo account Google Cloud vengano addebitati costi. Consulta: Esegui la 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.
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
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
- Prendi nota dell'ID progetto perché ti servirà in seguito.
-
È necessaria un'applicazione per inviare richieste l'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 haicurl
, puoi scaricarlo dalcurl
Pagina Release e download. - Utenti Windows: questo tutorial fornisce un esempio di utilizzo
Invoke-WebRequest
, ovvero supportato in PowerShell 3.0 e versioni successive.
- Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di
- Scarica Google Cloud CLI.
-
Aggiorna l'interfaccia a riga di comando gcloud 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: Seleziona un account nella nuova scheda del browser che si apre.gcloud auth login
-
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 gestirle, consulta Gestione gcloud CLI di comando gcloud.
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 poter connetterti all'istanza VM.
- In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
- Ora puoi utilizzare il terminale per eseguire i comandi Linux su Debian in esecuzione in un'istanza Compute Engine.
- 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 è pronto, viene elencato nella pagina Istanze VM, con un'icona di stato verde.
Download del codice campione
Scarica il codice di esempio nella macchina locale.
Per clonare o scaricare l'API di esempio:
- Clona il repository dell'app di esempio nella 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'anteprima come file ZIP ed estrarlo.
- 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 il tuo
La variabile di ambiente
GOPATH
è 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'anteprima come file ZIP ed estrarlo.
- 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 nella 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
è basato su
Specifica OpenAPI v2.0.
Devi 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 Node.js Tieni presente quanto segue:
- L'esempio di configurazione mostra le linee vicino a
host
, che dovrai 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 non necessaria per questo tutorial. Non è necessario configurare le righe con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID. - OpenAPI è una specifica indipendente dalla lingua. Per comodità, lo stesso file
openapi.yaml
è presente nell'esempiogetting-started
in ogni repository GitHub per ogni lingua.
- L'esempio di configurazione mostra le linee vicino a
- 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 si tratta del modello completo
nome di dominio (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 riportati di seguito per poter inviare richieste all'API di esempio utilizzando un indirizzo IP, consulta la sezione 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 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 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 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 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
è 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 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 nella pagina Endpoints > Servizi della console Google Cloud.
Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints.
Verifica dei servizi richiesti
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, ma
non attiva 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 un progetto Google Cloud esistente 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.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 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 è 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 camponame
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 configurare Docker nell'istanza VM ed 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 relative autorizzazioni.
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, consulta Che cosa sono i ruoli e le autorizzazioni?
Installa Docker sull'istanza VM
Per installare Docker sull'istanza VM:
- Imposta la zona per il 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 versioni successive
- x86_64/amd64
Esegui l'API e 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 autenticazione, gestione delle chiavi API, 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 contenitori 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
Node.js sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-node:1.0
- Esegui il container Docker ESPv2 pubblico precompilato.
Nelle opzioni di avvio di ESPv2, sostituisci
SERVICE_NAME con il nome del tuo servizio. Questo è
lo 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 da utilizzare la configurazione del servizio di cui è stato eseguito il deployment più recente. Quando specifichi questa opzione, entro un minuto dal deployment di una nuova configurazione del servizio, ESPv2 rileva la modifica e inizia a utilizzarla automaticamente. Ti consigliamo di specificare questa opzione anziché fornire un ID configurazione specifico da utilizzare per ESPv2. Per informazioni sulle altre opzioni ESPv2 utilizzate sopra, vedi Opzioni di avvio di ESPv2.
Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi relativi agli endpoint su Compute Engine. Consulta: Deployment del backend delle API per ulteriori informazioni.
Invio di una richiesta utilizzando un indirizzo IP
Dopo aver eseguito l'API di esempio e ESPv2 sull'istanza Compute Engine, puoi inviare richieste all'API dalla tua macchina locale.
Creare una chiave API e impostare una variabile di ambiente
Il codice di esempio richiede una chiave API. Per semplificare la richiesta, imposta una variabile di ambiente per la chiave API.
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
- Fai clic su Crea credenziali e poi 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 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 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 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, vedi Invoke-WebRequest nel documentazione.
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 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 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.
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:
- 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 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"
- Nella proprietà
name
, sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto. - Nella proprietà
target
, sostituisci IP_ADDRESS con l'indirizzo IP 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 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 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
. La propagazione della nuova configurazione DNS potrebbe richiedere alcuni minuti.
Configurazione di SSL
Per maggiori dettagli su come configurare DNS e SSL, consulta Attivazione di SSL per 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 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:
- Esamina i grafici delle attività della tua API nella pagina Endpoints > Servizi.
Vai alla pagina Servizi endpoint
La visualizzazione dei dati relativi alle richieste nei grafici può richiedere alcuni minuti. - Controlla 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 gli 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.
- Elimina l'API:
gcloud endpoints services delete SERVICE_NAME
Sostituisci
SERVICE_NAME
con il nome del tuo servizio. - In the Google Cloud console, go to the VM instances page.
- Select the checkbox for the instance that you want to delete.
- To delete the instance, click More actions, click Delete, and then follow the instructions.