Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy V2 (ESPv2) in un cluster Kubernetes non su Google Cloud. Se vuoi utilizzare Google Kubernetes Engine (GKE), consulta Iniziare a utilizzare Endpoints su GKE.
L'API REST del codice campione è descritta utilizzando la specifica OpenAPI. Il tutorial mostra anche come creare una chiave API per inviare richieste all'API.
Il tutorial utilizza immagini container precompilate del codice campione e di ESPv2, archiviate in Artifact Registry. Se non hai familiarità con i container, consulta quanto segue per saperne di più:
Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints e Architettura di Endpoints.
Obiettivi
Segui il seguente elenco di attività di alto livello durante il tutorial. Tutte le attività della Parte 1 sono necessarie per inviare correttamente le richieste all'API.
Parte 1
- Configurare un progetto Google Cloud. Vedi Prima di iniziare.
- Installa e configura il software utilizzato nel tutorial. Consulta Installare e configurare il software necessario.
- Se vuoi, scarica il codice campione. Consulta Recupero del codice di esempio.
- Scarica il file di configurazione di Kubernetes. Consulta Ottenere il file di configurazione di Kubernetes.
- Configura il file
openapi.yaml
, utilizzato per configurare Endpoints. Consulta Configurare Endpoints. - Esegui il deployment della configurazione di Endpoints per creare un servizio Cloud Endpoints. Consulta Eseguire il deployment della configurazione di Endpoints.
- Crea le credenziali per il servizio Endpoints. Consulta Creare le credenziali per il servizio.
- Esegui il deployment dell'API e di ESPv2 nel cluster. Consulta Eseguire il deployment del backend dell'API.
- Recupera l'indirizzo IP esterno del servizio. Consulta Ottenere l'indirizzo IP esterno.
- Invia una richiesta all'API utilizzando un indirizzo IP. Consulta Inviare una richiesta utilizzando un indirizzo IP.
- Monitora l'attività dell'API. Consulta Monitorare l'attività dell'API.
Parte 2
- Configura un record DNS per l'API di esempio. Consulta Configurare il DNS per gli endpoint.
- Invia una richiesta all'API utilizzando il nome di dominio. Consulta Inviare una richiesta utilizzando l'FQDN.
Pulizia
Al termine, consulta la sezione Eseguire la pulizia per evitare che al tuo account Google Cloud vengano addebitati costi.
Costi
In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il Calcolatore prezzi.
Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione Pulizia.
Prima di iniziare
Questo tutorial presuppone che tu abbia già configurato Minikube o un cluster Kubernetes. Per saperne di più, consulta la documentazione di Kubernetes.
- 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 Google Cloud perché ti servirà in seguito.
Installazione e configurazione del software necessario
In questo tutorial, installi Google Cloud CLI per utilizzare gcloud CLI per gestire il tuo progetto.
Utilizza kubectl
,
un'interfaccia a riga di comando, per eseguire comandi sui cluster Kubernetes. Inoltre,
abbi bisogno di un modo per testare l'API.
Nella procedura che segue, se hai già installato il software richiesto, vai al passaggio successivo.
Per installare e configurare il software necessario:
-
Devi disporre di un'applicazione per inviare richieste all'API di esempio.
- Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di
curl
, che in genere è preinstallato sul sistema operativo. Se non haicurl
, puoi scaricarlo dallacurl
pagina Release e download. - Utenti Windows: questo tutorial fornisce un esempio di utilizzo di
Invoke-WebRequest
, supportato in PowerShell 3.0 e versioni successive.
- Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di
- Installa e inizializza la gcloud CLI.
-
Aggiorna l'interfaccia a riga di comando gcloud e installa i componenti Endpoints:
gcloud components update
-
Assicurati che Google Cloud CLI (
gcloud
) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud: Nella nuova scheda visualizzata, seleziona un account.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 utilizzarli con
gcloud
per gestirli, consulta Gestire la gcloud CLI gcloud. - Installa
kubectl
:gcloud components install kubectl
-
Acquisisci nuove credenziali utente da utilizzare per le credenziali predefinite dell'applicazione.
Le credenziali utente autorizzano
kubectl
.gcloud auth application-default login
- Nella nuova scheda visualizzata, scegli un account.
- Esegui il seguente comando per assicurarti che il client Kubernetes sia configurato correttamente:
kubectl version
Dovresti vedere un output simile al seguente:
Client Version: version.Info{Major:"1", Minor:"8", GitVersion:"v1.8.4", GitCommit:"9befc2b8928a9426501d3bf62f72849d5cbcd5a3", GitTreeState:"clean", BuildDate:"2017-11-20T05:28:34Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"linux/amd64"} Server Version: version.Info{Major:"1", Minor:"7+", GitVersion:"v1.7.8-gke.0", GitCommit:"a7061d4b09b53ab4099e3b5ca3e80fb172e1b018", GitTreeState:"clean", BuildDate:"2017-10-10T18:48:45Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"linux/amd64"}
Download del codice campione
Se vuoi, scarica il codice campione. In questo tutorial esegui il deployment di un'immagine container predefinita, quindi non devi creare un container dal codice campione. Tuttavia, ti consigliamo di scaricare il codice campione, fornito in diversi linguaggi, per capire come funziona l'API di esempio.
Per scaricare il codice campione:
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
Ottenere il file di configurazione di Kubernetes
Clona il repository GitHub contenente i file
yaml
utilizzati in questo tutorial sulla tua macchina locale:git clone https://github.com/googlecloudplatform/endpoints-samples
In alternativa, scarica il sample come file ZIP ed estrailo.
Passa alla directory che contiene i file di configurazione:
cd endpoints-samples/kubernetes
Configurazione di Endpoints
Il codice campione include il file di configurazione OpenAPI openapi.yaml
, che si basa sulla specifica OpenAPI 2.0.
Per configurare Endpoints:
- Nella directory codice campione, apri il file di configurazione
openapi.yaml
.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
è presente nell'esempiogetting-started
in ogni repository GitHub per ogni lingua.
- L'esempio di configurazione mostra le righe vicino al campo
- Nel campo
host
, sostituisci il testo con il nome del servizio Endpoints, che deve avere il seguente formato:host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
Sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloud. Ad esempio:
host: "echo-api.endpoints.example-project-12345.cloud.goog"
Tieni presente che echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
è il nome del servizio Endpoints. Non è il nome di dominio completo (FQDN) che utilizzi per inviare richieste all'API.
Per informazioni sui campi nel documento OpenAPI richiesti da Endpoints, consulta Configurare Endpoints.
Dopo aver completato tutti i passaggi di configurazione che seguono e aver inviato correttamente richieste all'API di esempio utilizzando un indirizzo IP, consulta Configurazione del DNS per gli endpoint per informazioni su come configurare echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
come FQDN.
esegui il deployment della configurazione di Endpoints
Per eseguire il deployment della configurazione di Endpoints, utilizza il comando gcloud endpoints
services deploy
. Questo comando utilizza Gestione servizi per creare un servizio gestito.
Per eseguire il deployment della configurazione di Endpoints:
- Assicurati di essere nella directory
endpoints-samples/kubernetes
. - Carica la configurazione e crea un servizio gestito:
gcloud endpoints services deploy openapi.yaml
Il comando gcloud
chiama quindi l'API Service Management per creare un servizio gestito con il nome specificato nel campo host
del file openapi.yaml
.
Service Management configura il servizio in base alle impostazioni nel file openapi.yaml
. Quando apporti modifiche a openapi.yaml
, devi eseguire nuovamente il deployment del file per aggiornare il servizio Endpoints.
Durante la creazione e la configurazione del servizio, Service Management visualizza informazioni nel terminale. Puoi ignorare tranquillamente gli avvisi relativi ai percorsi nel file openapi.yaml
che non richiedono una chiave API.
Al termine della configurazione del servizio, Service Management visualizza un messaggio con l'ID configurazione del servizio e il nome del servizio, simile al seguente:
Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]
Nell'esempio precedente, 2017-02-13r0
è l'ID configurazione del servizio e echo-api.endpoints.example-project-12345.cloud.goog
è il servizio Endpoints. L'ID configurazione del servizio è costituito da un timbro di data seguito da un numero di revisione. Se esegui di nuovo il deployment del file openapi.yaml
nello stesso giorno, il numero della revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoints > Servizi della console Google Cloud.
Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints.
Verifica dei servizi richiesti
Come minimo, Endpoints ed ESP richiedono l'abilitazione dei seguenti servizi Google:Nome | Titolo |
---|---|
servicemanagement.googleapis.com |
API Service Management |
servicecontrol.googleapis.com |
API Service Control |
Nella maggior parte dei casi, il comando gcloud endpoints services deploy
attiva questi
servizi obbligatori. Tuttavia, il comando gcloud
viene completato correttamente, ma
non attiva i servizi richiesti nelle seguenti circostanze:
Se hai utilizzato un'applicazione di terze parti come Terraform e non includi questi servizi.
Hai eseguito il deployment della configurazione di Endpoints in un progetto Google Cloud esistente in cui questi servizi sono stati disattivati esplicitamente.
Utilizza il seguente comando per verificare che i servizi richiesti siano abilitati:
gcloud services list
Se non vedi i servizi richiesti nell'elenco, attivali:
gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
Abilita anche il servizio Endpoints:
gcloud services enable ENDPOINTS_SERVICE_NAME
Per determinare ENDPOINTS_SERVICE_NAME, puoi:
Dopo aver eseguito il deployment della configurazione di Endpoints, vai alla pagina Endpoints nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Nome servizio.
Per OpenAPI, ENDPOINTS_SERVICE_NAME è il valore specificato nel campo
host
della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è il valore specificato nel camponame
della configurazione degli endpoint gRPC.
Per ulteriori informazioni sui comandi gcloud
, consulta
Servizi gcloud
.
Creazione delle credenziali per il servizio
Per fornire la gestione della tua API, sia ESP che ESPv2 richiedono i servizi in Infrastruttura di servizi. Per chiamare questi servizi, ESP ed ESPv2 devono utilizzare token di accesso. Quando esegui il deployment di ESP o ESPv2 in ambienti Google Cloud, come GKE, Compute Engine o l'ambiente flessibile di App Engine, ESP ed ESPv2 ottengono i token di accesso per te tramite il servizio di metadati di Google Cloud.
Quando esegui il deployment di ESP o ESPv2 in un ambiente non Google Cloud, come il tuo computer locale, un cluster Kubernetes on-premise o un altro fornitore cloud, devi fornire un file JSON dell'account di servizio contenente una chiave privata. ESP ed ESPv2 utilizzano l'account di servizio per generare token di accesso per chiamare i servizi di cui ha bisogno per gestire la tua API.
Puoi utilizzare la console Google Cloud o Google Cloud CLI per creare l'account di servizio e il file della chiave privata:
Console
- Nella console Google Cloud, apri la pagina Account di servizio .
- Fai clic su Seleziona un progetto.
- Seleziona il progetto in cui è stata creata l'API e fai clic su Apri.
- Fai clic su + Crea account di servizio.
- Nel campo Nome account di servizio, inserisci il nome dell'account di servizio.
- Fai clic su Crea.
- Fai clic su Continua.
- Fai clic su Fine.
- Fai clic sull'indirizzo email dell'account di servizio appena creato.
- Fai clic su Chiavi.
- Fai clic su Aggiungi chiave, quindi su Crea nuova chiave.
Fai clic su Crea. Un file della chiave JSON viene scaricato sul computer.
Assicurati di archiviare il file della chiave in modo sicuro perché può essere utilizzato per l'autenticazione come account di servizio. Puoi spostare e rinominare il file come preferisci.
Fai clic su Chiudi.
gcloud
Inserisci quanto segue per visualizzare gli ID progetto per i tuoi progetti Google Cloud:
gcloud projects list
Sostituisci PROJECT_ID nel seguente comando per impostare il progetto predefinito su quello in cui si trova l'API:
gcloud config set project PROJECT_ID
Assicurati che Google Cloud CLI (
gcloud
) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud:gcloud auth login
Se hai più di un account, assicurati di scegliere quello che si trova nel progetto Google Cloud in cui si trova l'API. Se esegui
gcloud auth list
, l'account selezionato viene visualizzato come account attivo per il progetto.Per creare un account di servizio, esegui il seguente comando e sostituisci SERVICE_ACCOUNT_NAME e
My Service Account
con il nome e il nome visualizzato che vuoi utilizzare:gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \ --display-name "My Service Account"
Il comando assegna un indirizzo email per l'account di servizio nel seguente formato:
SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Questo indirizzo email è obbligatorio nei comandi successivi.
Crea un file della chiave dell'account di servizio:
gcloud iam service-accounts keys create ~/service-account-creds.json \ --iam-account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Aggiungi i ruoli IAM richiesti:
Questa sezione descrive le risorse IAM utilizzate da ESP e ESPv2 e i ruoli IAM richiesti per l'accesso di questo account di servizio alle risorse.
Configurazione del servizio endpoint
ESP ed ESPv2 chiamano Service Control, che utilizza la configurazione del servizio endpoint. La configurazione del servizio endpoint è una risorsa IAM ed ESP ed ESPv2 richiedono il ruolo Responsabile controllo servizi per accedervi.
Il ruolo IAM si trova nella configurazione del servizio endpoint, non nel progetto. Un progetto può avere più configurazioni di servizi endpoint.
Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio associato per la configurazione del servizio endpoint.
gcloud endpoints services add-iam-policy-binding SERVICE_NAME \ --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \ --role roles/servicemanagement.serviceController
Dove
* SERVICE_NAME
è il nome del servizio endpoint
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com
è l'account di servizio associato.
Cloud Trace
ESP ed ESPv2 chiamano il servizio
Cloud Trace per
esportare la traccia in un progetto. Questo progetto è chiamato progetto di monitoraggio. In ESP, il progetto di monitoraggio e il progetto proprietario della configurazione del servizio endpoint sono gli stessi. In ESPv2, il progetto di monitoraggio può essere specificato tramite il flag --tracing_project_id
e per impostazione predefinita corrisponde al progetto di implementazione.
ESP ed ESPv2 richiedono il ruolo Agente Cloud Trace per abilitare Cloud Trace.
Utilizza il seguente comando gcloud per aggiungere il ruolo all'account di servizio collegato:
gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \ --role roles/cloudtrace.agent
Dove
* TRACING_PROJECT_ID è l'ID progetto di monitoraggio
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com
è l'account di servizio associato.
Per ulteriori informazioni, consulta
Che cosa sono i ruoli e le autorizzazioni?
Per ulteriori informazioni sui comandi, consulta
gcloud iam service-accounts
.
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 illustra come eseguire il deployment di container predefiniti per l'API di esempio e ESPv2 in Kubernetes.
Controllo delle autorizzazioni richieste
Concedi le autorizzazioni necessarie al account di servizio associato al tuo cluster:
gcloud endpoints services add-iam-policy-binding SERVICE_NAME \ --member "serviceAccount:SERVICE_ACCOUNT" \ --role roles/servicemanagement.serviceController
Per ulteriori informazioni, consulta Che cosa sono i ruoli e le autorizzazioni?
Fornire a ESPv2 le credenziali di servizio
ESPv2, che viene eseguito all'interno di un contenitore, deve accedere alle credenziali archiviate localmente nel file service-account-creds.json
. Per fornire
a ESPv2 l'accesso alle credenziali, devi creare un
secret di Kubernetes
e montarlo come
volume Kubernetes.
Per creare il secret di Kubernetes e montare il volume:
- Assicurati di rinominare il file JSON in
service-account-creds.json
e di copiarlo inendpoints-samples/kubernetes
se è stato scaricato in una directory diversa. In questo modo, il nome corrisponde alle opzioni specificate nelecho.yaml
file manifest di deployment. - Assicurati di essere nella directory
endpoints-samples/kubernetes
. Crea un secret Kubernetes con le credenziali dell'account di servizio utilizzando il seguente comando:
kubectl create secret generic service-account-creds \ --from-file=service-account-creds.json
In caso di esito positivo, viene visualizzato il seguente messaggio:
secret "service-account-creds" created
Il file manifest di deployment utilizzato per eseguire il deployment dell'API e di ESPv2 in Kubernetes contiene già il volume segreto, come mostrato nelle due sezioni seguenti del file:
Configurazione del nome del servizio e avvio del servizio
ESPv2 deve conoscere il nome del servizio per trovare la configurazione di cui hai eseguito il deployment in precedenza (utilizzando il comando gcloud endpoints services deploy
).
Per configurare il nome del servizio e avviarlo:
Apri il file manifest di deployment,
echo.yaml
, e sostituisci SERVICE_NAME nelle opzioni di avvio di ESPv2 con il nome del servizio. Si tratta dello stesso nome configurato nelhost
campo del documento OpenAPI. Ad esempio:"--service=echo-api.endpoints.example-project-12345.cloud.goog"
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, consulta Opzioni di avvio di ESPv2.Avvia il servizio per eseguire il deployment del servizio Endpoints su Kubernetes con il seguente comando:
kubectl create -f echo.yaml
Se viene visualizzato un messaggio di errore simile al seguente:
The connection to the server localhost:8080 was refused - did you specify the right host or port?
Ciò indica che
kubectl
non è configurato correttamente. Per ulteriori informazioni, consulta Configurare kubectl. Per ulteriori informazioni, consulta Eseguire il deployment di endpoint su Kubernetes.
Ottieni l'indirizzo IP esterno del servizio
Se utilizzi Minikube, vai a Invio di una richiesta utilizzando un indirizzo IP. Potrebbero essere necessari alcuni minuti dopo l'avvio del servizio nel contenitore prima che l'indirizzo IP esterno sia pronto.
Per visualizzare l'indirizzo IP esterno del servizio:
Esegui questo comando:
kubectl get service
Prendi nota del valore di EXTERNAL-IP. Utilizza questo indirizzo IP quando invii una richiesta all'API di esempio.
Invio di una richiesta utilizzando un indirizzo IP
Una volta che l'API di esempio è in esecuzione nel cluster di container, puoi inviare richieste all'API.
Crea una chiave API e imposta una variabile di ambiente
Il codice campione richiede una chiave API. Per semplificare la richiesta, imposta una variabile di ambiente per la chiave API.
Nello stesso progetto Google Cloud utilizzato per l'API, crea una chiave API nella pagina delle 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 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 a minikube
I comandi seguenti utilizzano la variabile di ambiente ENDPOINTS_KEY impostata precedentemente.
Linux o Mac OS
NODE_PORT=`kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}'`
MINIKUBE_IP=`minikube ip`
curl --request POST \
--header "content-type:application/json" \
--data '{"message":"hello world"}' \
${MINIKUBE_IP}:${NODE_PORT}/echo?key=${ENDPOINTS_KEY}
PowerShell
$Env:NODE_PORT=$(kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}')
$Env:MINIKUBE_IP=$(minikube ip)
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
-Headers @{"content-type"="application/json"} `
-URI "http://$Env:MINIKUBE_IP:$Env:NODE_PORT/echo?key=$Env:ENDPOINTS_KEY").Content
Invia la richiesta ad altri cluster Kubernetes
Linux o Mac OS
Utilizza curl
per inviare una richiesta HTTP utilizzando la variabile di ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con
l'indirizzo IP esterno della tua istanza.
curl --request POST \ --header "content-type:application/json" \ --data '{"message":"hello world"}' \ "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"
Nel curl
precedente:
- L'opzione
--data
specifica i dati da pubblicare nell'API. - L'opzione
--header
specifica che i dati sono in formato JSON.
PowerShell
Utilizza Invoke-WebRequest
per inviare una richiesta HTTP utilizzando la variabile di ambiente ENDPOINTS_KEY
impostata in precedenza. Sostituisci
IP_ADDRESS con l'indirizzo IP esterno della
console.
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' ` -Headers @{"content-type"="application/json"} ` -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content
Nell'esempio precedente, le prime due righe terminano con un backtick. Quando incolli l'esempio in PowerShell, assicurati che non ci sia uno spazio dopo i backtick. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, consulta Invoke-WebRequest nella documentazione di Microsoft.
App di terze parti
Puoi utilizzare un'applicazione di terze parti come l'estensione del browser Chrome Postman per inviare la richiesta:
- Seleziona
POST
come verbo HTTP. - Per l'intestazione, seleziona la chiave
content-type
e il 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 la sezione Risoluzione dei problemi relativi alle risposte.
Hai eseguito il deployment e il test di un'API in Endpoints.
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 alla richiesta nei grafici può richiedere alcuni minuti.Esamina i log delle richieste per la tua API nella pagina Esplora log.
Configurazione del DNS per gli endpoint
Poiché il nome del servizio Endpoints per l'API si trova nel
dominio .endpoints.YOUR_PROJECT_ID.cloud.goog
, puoi usarlo come nome di dominio completo (FQDN) apportando una piccola
modifica alla configurazione nel file openapi.yaml
. In questo modo, puoi
inviare richieste all'API di esempio utilizzando
echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
instead of the IP address.
Per configurare il DNS di Endpoints:
- Apri il file di configurazione OpenAPI
openapi.yaml
e aggiungi la proprietàx-google-endpoints
al livello superiore del file (senza rientrare o nidificare) come mostrato nello snippet seguente:host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog" x-google-endpoints: - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog" target: "IP_ADDRESS"
- 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 comando gcloud
precedente, Service Management crea un record A DNS, echo-api.endpoints.my-project-id.cloud.goog
, che risolve nell'indirizzo IP di destinazione 192.0.2.1
. Potrebbero essere necessari alcuni minuti prima che la nuova configurazione DNS venga propagata.
Configurazione di SSL
Per ulteriori dettagli su come configurare DNS e SSL, consulta Attivare SSL per gli endpoint.
Invio di una richiesta all'FQDN
Ora che hai configurato il record DNS per l'API di esempio, invia una richiesta utilizzando l'FQDN (sostitui YOUR_PROJECT_ID con il tuo ID progetto) e la variabile di ambiente ENDPOINTS_KEY impostata in precedenza:- In Linux o macOS:
curl --request POST \ --header "content-type:application/json" \ --data '{"message":"hello world"}' \ "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"
- In Windows PowerShell:
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content
Creazione di un portale per gli sviluppatori per l'API
Puoi utilizzare il portale Cloud Endpoints per creare un portale per gli sviluppatori, un sito web che puoi utilizzare per interagire con l'API di esempio. Per saperne di più, consulta la panoramica del portale Cloud Endpoints.
Esegui la pulizia
Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.
- Elimina il servizio e il deployment Kubernetes:
kubectl delete -f echo.yaml
Consulta la sezione Eliminare un'API e le relative istanze per informazioni su come interrompere i servizi utilizzati da questo tutorial.