Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy (ESP) in esecuzione 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 ed architettura degli endpoint.
Obiettivi
Durante il tutorial, utilizza il seguente elenco di attività di alto livello. Tutte le attività sono obbligatorie per inviare correttamente le richieste all'API.
- Configurare un progetto Google Cloud. Consulta la pagina Prima di iniziare.
- Creare un'istanza VM di Compute Engine. Consulta Creazione di un'istanza Compute Engine.
- Scarica il codice campione. Vedi Generare il codice campione.
- Configura il file
openapi.yaml
, che viene utilizzato per configurare gli endpoint. Vedi Configurazione degli endpoint. - Eseguire il deployment della configurazione Endpoint per creare un servizio Endpoint. Vedi Deployment della configurazione endpoint.
- Eseguire il deployment dell'API e dell'ESP sulla VM di Compute Engine. Vedi Deployment del backend API.
- Inviare una richiesta all'API utilizzando un indirizzo IP. Vedi Inviare una richiesta utilizzando l'indirizzo IP.
- Configura un record DNS per l'API di esempio. Vedi Configurazione di DNS per endpoint.
- 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 Attività dell'API di monitoraggio.
- Evita di ricevere addebiti sul tuo account Google Cloud. Vedi Pulizia.
Costi
Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il Calcolatore prezzi.
Al termine di questo tutorial, puoi evitare una fatturazione continua eliminando le risorse che hai creato. Per scoprire di più, vedi 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.
-
Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.
-
Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.
- Prendi nota dell'ID progetto perché è necessario in seguito.
-
È necessaria un'applicazione per inviare richieste all'API di esempio.
- Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di
curl
, che in genere è preinstallato sul sistema operativo. Se non hai l'appcurl
, puoi scaricarla dallacurl
pagina Release e download. - Utenti Windows: questo tutorial fornisce un esempio utilizzando
Invoke-WebRequest
, supportato in PowerShell 3.0 e versioni successive.
- Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di
- Scarica Google Cloud CLI.
-
Aggiornare l'interfaccia a riga di comando gcloud e installare i componenti 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
Seleziona un account nella nuova scheda del browser che si apre. -
Imposta il progetto predefinito sull'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 Gestire le configurazioni dell'interfaccia a riga di comando gcloud.
Al termine di questo tutorial, puoi evitare una fatturazione continua eliminando le risorse che hai creato. Per scoprire di più, vedi Pulizia.
Creazione di un'istanza Compute Engine
- Nella console Google Cloud, vai alla pagina Crea un'istanza.
- 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.
- Nell'elenco delle istanze della macchina virtuale, 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, della zona e dell'indirizzo IP esterno dell'istanza perché sono necessari in un secondo momento.
Per creare un'istanza di Compute Engine:
Potrebbe essere necessario un po' di tempo per l'avvio dell'istanza. Una volta completata, viene elencata nella pagina Istanze VM con un'icona di stato verde.
Download del codice campione
Scarica il codice campione sulla macchina locale.
Per clonare o scaricare l'API di esempio:
- Clona il repository dell'app di esempio nella 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 nella 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 nella 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 nella 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 nella 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 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.
Configura ed esegui il deployment di openapi.yaml
sulla tua macchina locale.
Per configurare gli endpoint:
- Nella directory del codice di esempio, apri il file di configurazione di
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 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
è nell'esempiogetting-started
in ogni repository GitHub in ogni lingua.
- L'esempio di configurazione mostra le righe vicino al campo
- Nel campo
host
, sostituisci il testo con il nome del servizio endpoint, che dovrebbe essere nel seguente formato:host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
Sostituisci YOUR_PROJECT_ID con l'ID 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
che utilizzi per inviare richieste all'API.
Per informazioni sui campi del documento OpenAPI richiesti da Endpoints, consulta la configurazione degli endpoint.
Dopo aver completato tutti i passaggi di configurazione seguenti, in modo da poter inviare correttamente le richieste all'API di esempio utilizzando un indirizzo IP, consulta la pagina relativa alla configurazione del DNS di endpoint per informazioni su come configurare echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
il nome di dominio completo.
Eseguire il deployment della configurazione di Endpoints
Per eseguire il deployment della configurazione Endpoint puoi utilizzare il comando gcloud endpoints
services deploy
. Questo comando utilizza Service Management per creare un servizio gestito.
Per eseguire il deployment della configurazione 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 informazioni al terminale. Puoi ignorare in tutta sicurezza 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 e il nome del servizio di servizio, in modo 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 di servizio e echo-api.endpoints.example-project-12345.cloud.goog
è il servizio Endpoint. L'ID di configurazione del servizio è costituito da un timbro data seguito da un numero di revisione. Se esegui nuovamente il deployment del file openapi.yaml
nello stesso giorno, il numero di revisione viene aumentato nell'ID configurazione di servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoint > Servizi della console Google Cloud.
Se viene visualizzato un messaggio di errore, vedi Risolvere i problemi di deployment della configurazione degli endpoint.
Verifica dei servizi richiesti
Come minimo, endpoint ed ESP richiedono l'abilitazione dei seguenti servizi Google:Nome | Qualifica |
---|---|
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 Endpoint in un progetto Google Cloud esistente in cui questi servizi sono stati disattivati 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
Attiva anche il servizio Endpoints:
gcloud services enable ENDPOINTS_SERVICE_NAME
Per determinare il ENDPOINTS_SERVICE_NAME puoi:
Dopo aver eseguito il deployment della configurazione Endpoint, vai alla pagina Endpoint nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Nome servizio.
Per OpenAPI, il valore di ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo
host
della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel camponame
della configurazione degli endpoint gRPC.
Per maggiori informazioni sui comandi gcloud
, consulta
i 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 che gestisce il backend dell'API. Questa sezione illustra come configurare Docker nell'istanza VM ed eseguire il codice di backend dell'API e ESP in un container Docker.
Verifica delle autorizzazioni richieste
- Nella console Google Cloud, vai alla pagina Istanze Compute Engine.
- Seleziona la tua istanza dall'elenco.
- Puoi vedere l'account di servizio associato e le autorizzazioni che ha.
Concedi le autorizzazioni richieste all'account di servizio:
gcloud projects add-iam-policy-binding PROJECT_NAME
--member "serviceAccount:SERVICE_ACCOUNT"
--role roles/servicemanagement.serviceControllerPer saperne di più, 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 che corrispondono alla versione e all'architettura dell'istanza VM:
- Jessie o più recente
- x86_64 / amd64
Esegui l'API e l'ESP in un container Docker
ESP è un proxy basato su nginx
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 e l'ESP di esempio in un container Docker:
- Crea la tua rete di container chiamata
esp_net
.sudo docker network create --driver bridge esp_net
- Esegui il server Echo di esempio che pubblica 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 ESP pubblico preconfezionato.
Nelle opzioni di avvio ESP, 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 \ --name=esp \ --detach \ --publish=80:8080 \ --net=esp_net \ gcr.io/endpoints-release/endpoints-runtime:1 \ --service=SERVICE_NAME \ --rollout_strategy=managed \ --backend=echo:8080
L'opzione
--rollout_strategy=managed
configura ESP in modo da utilizzare la configurazione del servizio più recente sottoposta a deployment. Quando specifichi questa opzione, fino a 5 minuti dopo il deployment di una nuova configurazione del servizio, ESP rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione invece di un ID di configurazione specifico da utilizzare per ESP. Per informazioni sulle altre opzioni ESP utilizzate sopra, vedi Opzioni di avvio ESP.
Se viene visualizzato un messaggio di errore, vedi Risoluzione dei problemi di Endpoints su Compute Engine.
Per ulteriori informazioni, consulta la pagina relativa al deployment del backend API.
Invio di una richiesta tramite un indirizzo IP
Dopo che l'API di esempio e l'ESP sono in esecuzione sull'istanza di Compute Engine, puoi inviare le 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, 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 pagina Credenziali API. Se vuoi creare una chiave API in un progetto Google Cloud diverso, consulta Abilitare un'API nel progetto Google Cloud.
- Fai clic su Crea credenziali, quindi seleziona Chiave API.
- Copia la chiave negli appunti.
- Fai clic su Chiudi.
- Incolla la chiave API sul computer locale 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 tramite la variabile di ambiente ENDPOINTS_KEY che hai impostato 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 tramite la variabile di ambiente ENDPOINTS_KEY
che hai impostato in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della tua 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 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 valoreapplication/json
. - Inserisci il testo seguente:
{"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 fa eco al messaggio che invii e risponde con quanto segue:
{
"message": "hello world"
}
Se non hai ricevuto correttamente una risposta, consulta la sezione Risolvere gli errori di risposta.
Hai appena eseguito il deployment e il test di un'API in Endpoints.
Configurazione di DNS per Endpoints
Poiché il nome del 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 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"
- Nella proprietà
name
, sostituisci YOUR_PROJECT_ID con l'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 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 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 ulteriori dettagli sulla configurazione di DNS e SSL, consulta la pagina relativa all'abilitazione di SSL per gli endpoint.
Invio di una richiesta utilizzando FQDN
Ora che il record DNS è configurato per l'API di esempio, invia una richiesta utilizzando l'FQDN (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
Monitora l'attività dell'API
Per monitorare l'attività dell'API:
Dai un'occhiata ai grafici relativi alle attività della tua API nella pagina Endpoint > Servizi.
Vai alla pagina Servizi di Endpoints
Potrebbe essere necessario qualche istante affinché la richiesta venga visualizzata nei grafici.Esamina i log delle richieste per l'API nella pagina Esplora log.
Creazione di un portale per sviluppatori per l'API
Puoi usare il portale Cloud Endpoints per creare un portale per gli sviluppatori, un sito web da utilizzare per interagire con l'API di esempio. Per scoprire 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.
- Elimina l'API:
gcloud endpoints services delete SERVICE_NAME
Sostituisci
SERVICE_NAME
con il nome del tuo servizio. - In Google Cloud Console, vai alla pagina Istanze VM.
- Seleziona la casella di controllo l'istanza che vuoi eliminare.
- Per eliminare l'istanza, fai clic su Altre azioni, poi su Elimina e segui le istruzioni.