Iniziare a utilizzare Cloud Endpoints per Compute Engine con ESPv2

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 è 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 su Endpoints e Architettura di Endpoints.

Obiettivi

Utilizza il seguente elenco di attività di alto livello mentre segui il tutorial. Tutte le attività sono necessarie per inviare correttamente le richieste all'API.

  1. Configurare un progetto Google Cloud . Vedi Prima di iniziare.
  2. Creare un'istanza VM di Compute Engine. Consulta Creazione di un'istanza Compute Engine.
  3. Scarica il codice campione. Consulta la sezione Recupera il codice di esempio.
  4. Configura il file openapi.yaml, che viene utilizzato per configurare Endpoints. Vedi Configurazione di Endpoints.
  5. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Vedi Deployment della configurazione di Endpoints.
  6. Esegui il deployment dell'API e di ESPv2 sulla VM Compute Engine. Consulta Esegui il deployment del backend dell'API.
  7. Invia una richiesta all'API utilizzando un indirizzo IP. Consulta Invio di una richiesta utilizzando l'indirizzo IP.
  8. Configura un record DNS per l'API di esempio. Consulta Configurazione del DNS per Endpoints.
  9. Invia una richiesta all'API utilizzando il nome di dominio completo. Consulta la sezione Invio di una richiesta utilizzando l'FQDN.
  10. Monitora l'attività dell'API. Consulta Monitorare l'attività dell'API.
  11. Evita che al tuo account Google Cloud vengano addebitati costi. Vedi Pulizia.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.

I nuovi utenti di Google Cloud potrebbero avere diritto a una prova gratuita.

Al termine delle attività descritte in questo documento, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per saperne di più, consulta Esegui la pulizia.

Prima di iniziare

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. Prendi nota dell'ID progetto perché ti servirà in seguito.
  7. Per inviare richieste all'API di esempio, devi disporre di un'applicazione.

    • Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di curl, che in genere è preinstallato sul sistema operativo. Se non hai curl, puoi scaricarlo dalla curl pagina di download e release.
    • Utenti Windows: questo tutorial fornisce un esempio che utilizza Invoke-WebRequest, che è supportato in PowerShell 3.0 e versioni successive.
  8. Scarica Google Cloud CLI.
  9. Aggiorna gcloud CLI e installa i componenti di Endpoints.
    gcloud components update
  10. Assicurati che Google Cloud CLI (gcloud) sia autorizzata ad accedere ai tuoi dati e servizi su Google Cloud:
    gcloud auth login
    Nella nuova scheda del browser che si apre, seleziona un account.
  11. 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 Gestione delle configurazioni di gcloud CLI.

  12. Al termine delle attività descritte in questo documento, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per saperne di più, consulta Esegui la pulizia.

Creazione di un'istanza Compute Engine

    Per creare un'istanza Compute Engine:

    1. In the Google Cloud console, go to the Create an instance page.

      Go to Create an instance

    2. Nella sezione Firewall, seleziona Consenti traffico HTTP e Consenti traffico HTTPS.
    3. Per creare la VM, fai clic su Crea.
    4. Screenshot della finestra di creazione dell'istanza VM con le opzioni richieste impostate

      Potrebbe essere necessario un po' di tempo per l'avvio dell'istanza. Una volta pronto, viene elencato nella pagina Istanze VM con un'icona di stato verde.

    5. Assicurati di poterti connettere all'istanza VM.
      1. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
      2. Ora puoi utilizzare il terminale per eseguire comandi Linux sull'istanza Debian.
      3. Inserisci exit per disconnetterti dall'istanza.
    6. Prendi nota del nome dell'istanza, della zona e dell'indirizzo IP esterno perché ti serviranno in seguito.

Download del codice campione

Scarica il codice campione sulla tua macchina locale.

Java

Per clonare o scaricare l'API di esempio:

  1. 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.

  2. Passa alla directory che contiene il codice di esempio:
    cd java-docs-samples/endpoints/getting-started
Python

Per clonare o scaricare l'API di esempio:

  1. 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.

  2. Passa alla directory che contiene il codice di esempio:
    cd python-docs-samples/endpoints/getting-started
Vai

Per clonare o scaricare l'API di esempio:

  1. Assicurati che la variabile di ambiente GOPATH sia impostata.
  2. Clona il repository dell'app di esempio sulla tua macchina locale:
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Passa alla directory che contiene il codice di esempio:
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio sulla tua macchina locale:
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    In alternativa, scarica l'esempio come file ZIP ed estrailo.

  2. Passa alla directory che contiene il codice di esempio:
    cd php-docs-samples/endpoints/getting-started
Ruby

Per clonare o scaricare l'API di esempio:

  1. 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.

  2. Passa alla directory che contiene il codice di esempio:
    cd ruby-docs-samples/endpoints/getting-started
NodeJS

Per clonare o scaricare l'API di esempio:

  1. 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.

  2. Passa alla directory che contiene il codice di esempio:
    cd nodejs-docs-samples/endpoints/getting-started

Configurazione di Endpoints

Devi disporre di un documento OpenAPI basato su OpenAPI 2.0 o OpenAPI 3.x che descriva la superficie delle tue app e qualsiasi requisito di autenticazione. Per saperne di più, consulta Versioni di OpenAPI supportate.

Devi anche aggiungere un campo specifico di Google che contenga l'URL di ogni app in modo che ESPv2 disponga delle informazioni necessarie per richiamare un'app. Se non hai familiarità con OpenAPI, consulta la panoramica di OpenAPI per saperne di più.

OpenAPI 2.0

Per configurare Endpoints utilizzando una specifica OpenAPI 2.0, puoi utilizzare il file openapi.yaml disponibile nella directory endpoints/getting-started del codice campione scaricato.

I contenuti della specifica OpenAPI 2.0 dovrebbero essere simili ai seguenti:

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"

host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

consumes:
  - "application/json"
produces:
  - "application/json"

schemes:
# Uncomment the next line if you configure SSL for this API.
# - "https"
  - "http"

paths:
  /echo:
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
        - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
        -
          description: "Message to echo"
          in: body
          name: message
          required: true
          schema:
            $ref: "#/definitions/echoMessage"
      security:
        - api_key: []
  /auth/info/googlejwt:
    get:
      description: "Returns the requests' authentication information."
      operationId: "auth_info_google_jwt"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authenication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_jwt: []
  /auth/info/googleidtoken:
    get:
      description: "Returns the requests' authentication information."
      operationId: "authInfoGoogleIdToken"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authentication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_id_token: []

definitions:
  echoMessage:
    type: "object"
    properties:
      message:
        type: "string"
  authInfoResponse:
    properties:
      id:
        type: "string"
      email:
        type: "string"

securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"

  # This section configures authentication using Google API Service Accounts
  # to sign a json web token. This is mostly used for server-to-server
  # communication.
  google_jwt:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    # This must match the 'iss' field in the JWT.
    x-google-issuer: "jwt-client.endpoints.sample.google.com"
    # Update this with your service account's email address.
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
    # This must match the "aud" field in the JWT. You can add multiple
    # audiences to accept JWTs from multiple clients.
    x-google-audiences: "echo.endpoints.sample.google.com"
  # This section configures authentication using Google OAuth2 ID Tokens.
  # ID Tokens can be obtained using OAuth2 clients, and can be used to access
  # your API on behalf of a particular user.

  google_id_token:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v3/certs"
    # Your OAuth2 client's Client ID must be added here. You can add
    # multiple client IDs to accept tokens from multiple clients.
    x-google-audiences: "YOUR_CLIENT_ID"

OpenAPI 3.x

Per configurare Endpoints utilizzando una specifica OpenAPI 3.x, puoi sostituire i contenuti del file openapi.yaml disponibile nella directory endpoints/getting-started decodice campioneio scaricato:

  1. Apri il file openapi.yaml nell'editor di testo e sostituisci i contenuti con i seguenti:
    openapi: 3.0.4
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    servers:
      - url: "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
        x-google-endpoint: {}
    
    paths:
      /echo:
        post:
          description: "Echo back a given message."
          operationId: "echo"
          requestBody:
            description: "Message to echo"
            required: true
            content:
              "application/json":
                schema:
                  $ref: "#/components/schemas/echoMessage"
          responses:
            '200':
              description: "Echo"
              content:
                "application/json":
                  schema:
                    $ref: "#/components/schemas/echoMessage"
          security:
            - api_key: []
    
      /auth/info/googlejwt:
        get:
          description: "Returns the requests' authentication information."
          operationId: "auth_info_google_jwt"
          responses:
            '200':
              description: "Authentication info."
              content:
                "application/json":
                  schema:
                    $ref: "#/components/schemas/authInfoResponse"
          security:
            - api_key: []
              google_jwt: []
    
      /auth/info/googleidtoken:
        get:
          description: "Returns the requests' authentication information."
          operationId: "authInfoGoogleIdToken"
          responses:
            '200':
              description: "Authentication info."
              content:
                "application/json":
                  schema:
                    $ref: "#/components/schemas/authInfoResponse"
          security:
            - api_key: []
              google_id_token: []
    
    components:
      schemas:
        echoMessage:
          type: "object"
          properties:
            message:
              type: "string"
        authInfoResponse:
          properties:
            id:
              type: "string"
            email:
              type: "string"
    
      securitySchemes:
        api_key:
          type: "apiKey"
          name: "key"
          in: "query"
    
        google_jwt:
          type: "oauth2"
          flows:
            implicit:
              authorizationUrl: ""
              scopes: {}
          x-google-auth:
            issuer: "jwt-client.endpoints.sample.google.com"
            jwksUri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
            audiences:
            - "echo.endpoints.sample.google.com"
    
        google_id_token:
          type: "oauth2"
          flows:
            implicit:
              authorizationUrl: ""
              scopes: {}
          x-google-auth:
            issuer: "https://accounts.google.com"
            jwks_uri: "https://www.googleapis.com/oauth2/v3/certs"
            audiences:
              - "YOUR_CLIENT_ID"
  2. Salva i nuovi contenuti di openapi.yaml.

Questo tutorial utilizza un'estensione specifica di Google della specifica OpenAPI che consente di configurare il nome del servizio. Il metodo per specificare il nome del servizio dipende dalla versione della specifica OpenAPI che stai utilizzando.

OpenAPI 2.0

Utilizza il campo host per specificare il nome del servizio:

host: echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog

Per configurare Endpoints:

  1. Apri il file openapi.yaml.
  2. Nel campo host, sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloud .
  3. Salva il file openapi.yaml.

OpenAPI 3.x

Utilizza il campo url nell'oggetto servers per specificare il nome del servizio:

servers:
  - url: https://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
    x-google-endpoint: {}

Per configurare Endpoints:

  1. Apri il file openapi.yaml.
  2. Se il file openapi.yaml ha un campo host, rimuovilo.
  3. Aggiungi un oggetto servers come mostrato.
  4. Nel campo url, sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloud .
  5. Salva il file openapi.yaml.

Dopo aver completato tutti i seguenti passaggi di configurazione in modo da poter inviare correttamente 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 in modo che sia il nome di dominio completo (FQDN).

esegui il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione di Endpoints, utilizza il comando gcloud endpoints services deploy. Questo comando utilizza Service Management per creare un servizio gestito.

Per eseguire il deployment della configurazione di Endpoints:

  1. Assicurati di trovarti nella directory in cui si trova il file di configurazione openapi.yaml.
  2. 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 o servers.url 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 le informazioni nel 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 Endpoints. L'ID configurazione del servizio è composto da un timestamp seguito da un numero di revisione. Se esegui di nuovo il deployment del file openapi.yaml nello stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoints > Servizi nella console Google Cloud .

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints.

Controllo dei servizi richiesti

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 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 progettoGoogle Cloud esistente in cui questi servizi sono stati disattivati esplicitamente.

Utilizza questo comando per verificare che i servizi richiesti siano abilitati:

gcloud services list

Se non vedi i servizi richiesti elencati, 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 il 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 viene visualizzato nella colonna Nome servizio.

  • Per OpenAPI, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è ciò che hai specificato nel campo name della configurazione di gRPC Endpoints.

Per saperne di più sui comandi gcloud, consulta 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 ti guida nella configurazione di Docker sull'istanza VM e nell'esecuzione del codice backend dell'API e di ESPv2 in un container Docker.

Controllo delle autorizzazioni richieste

  • Nella console Google Cloud , vai alla pagina delle istanze Compute Engine.

    Vai alla pagina Compute Engine

  • Seleziona la tua istanza dall'elenco.
  • Puoi visualizzare il account di servizio associato e le relative autorizzazioni.
  • Concedi le autorizzazioni necessarie al account di servizio:

    gcloud projects add-iam-policy-binding PROJECT_NAME \
      --member "serviceAccount:SERVICE_ACCOUNT" \
      --role roles/servicemanagement.serviceController
    

    Per saperne di più, consulta Che cosa sono ruoli e autorizzazioni?

Installa Docker sull'istanza VM

Per installare Docker sull'istanza VM:

  1. 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.

  2. Connettiti all'istanza utilizzando il seguente comando:
    gcloud compute ssh INSTANCE_NAME
    

    Sostituisci INSTANCE_NAME con il nome dell'istanza VM.

  3. 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 backend. Elabora il traffico in entrata per fornire autenticazione, gestione delle chiavi API, logging e altre funzionalità di gestione delle API Endpoints. Per installare ed eseguire l'API di esempio e ESPv2 in un container Docker:

  1. Crea la tua rete di container denominata esp_net.
    sudo docker network create --driver bridge esp_net
    
  2. 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
    
  3. Esegui il container Docker ESPv2 pubblico precompilato. Nelle opzioni di avvio di ESPv2, sostituisci SERVICE_NAME con il nome del tuo servizio. Si tratta dello stesso nome che hai configurato come nome host nel 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 la configurazione del servizio di cui è stato eseguito il deployment più recente. Quando specifichi questa opzione, entro un minuto dopo il 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, vedi Opzioni di avvio di ESPv2.

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi di Endpoints su Compute Engine. Per ulteriori informazioni, consulta Deployment del backend API.

Invio di una richiesta utilizzando un indirizzo IP

Una volta che l'API di esempio e ESPv2 sono in esecuzione sull'istanza 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, imposta una variabile di ambiente per la chiave API.

  1. Nello stesso Google Cloud progetto che hai 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 Abilitare un'API nel tuo progetto Google Cloud .

    Vai alla pagina Credenziali

  2. Fai clic su Crea credenziali e poi seleziona Chiave API.
  3. Copia la chiave negli appunti.
  4. Fai clic su Chiudi.
  5. 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..."

Invia la richiesta

Linux o macOS

Utilizza curl per inviare una richiesta HTTP utilizzando 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}"

Nella 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 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 accento grave. Quando incolli l'esempio in PowerShell, assicurati che non ci sia uno spazio dopo gli apici inversi. 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 valore application/json.
  • Per il corpo, inserisci quanto segue:
    {"message":"hello world"}
  • Nell'URL, utilizza la chiave API effettiva anziché la variabile di ambiente. Ad esempio:
    http://192.0.2.0:80/echo?key=AIza...

L'API restituisce il messaggio che invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta riuscita, consulta la sezione Risoluzione dei problemi relativi agli errori di risposta.

Hai eseguito il deployment e il test di un'API in Endpoints.

Configurazione del DNS per Endpoints

<< "endpoints/docs/_shared/_configuring-endpoints-dns.md" >>

Invio di una richiesta utilizzando l'FQDN

<< "endpoints/docs/_shared/_send-request-fqdn.md" >>

monitora l'attività dell'API

Per monitorare l'attività dell'API:

  1. Guarda i grafici di 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.
  2. Esamina i log delle richieste per la tua API nella pagina Esplora log.

    Vai alla pagina Esplora log

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.

Esegui la pulizia

  1. Elimina l'API:
    gcloud endpoints services delete SERVICE_NAME

    Sostituisci SERVICE_NAME con il nome del servizio.

  2. In the Google Cloud console, go to the VM instances page.

    Go to VM instances

  3. Select the checkbox for the instance that you want to delete.
  4. To delete the instance, click More actions, click Delete, and then follow the instructions.

Passaggi successivi