Introduzione a Cloud Endpoints nell'ambiente flessibile di App Engine (.NET) con ESP

Questo tutorial mostra come configurare ed eseguire il deployment di un'API .NET core di esempio e dell'Extensible Service Proxy (ESP) in esecuzione su un'istanza nell'ambiente flessibile di App Engine. L'API REST di esempio di codice è descritta utilizzando la specifica OpenAPI. Il tutorial illustra anche come creare una chiave API e utilizzarla nella richiesta all'API.

Per una panoramica di Cloud Endpoints, consulta le informazioni sugli endpoint e l'architettura degli endpoint.

Obiettivi

Utilizza il seguente elenco di attività avanzate durante l'esecuzione del tutorial. Tutte le attività sono necessarie per inviare correttamente le richieste all'API.

  1. Configura un progetto Google Cloud, installa il software richiesto e crea un'applicazione App Engine. Vedi Prima di iniziare.
  2. Scarica il codice di esempio. Consulta la sezione Ottenere il codice di esempio.
  3. Configura il file openapi-appengine.yaml, che viene utilizzato per configurare gli endpoint. Vedi Configurazione degli endpoint.
  4. Esegui il deployment della configurazione Endpoint per creare un servizio Endpoint. Vedi Deployment della configurazione degli endpoint.
  5. Esegui il deployment dell'API di esempio e di ESP in App Engine. Vedi Deployment del backend dell'API.
  6. Invia una richiesta all'API. Consulta la pagina Invio di una richiesta all'API.
  7. Monitora l'attività dell'API. Consulta Attività dell'API di monitoraggio.
  8. 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. I nuovi utenti di Google Cloud possono beneficiare di una prova gratuita.

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

  1. 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.
  2. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

  4. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  5. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

  6. Prendi nota dell'ID progetto perché è necessario in un secondo momento.
  7. Questo tutorial richiede l'SDK.NET Core 2.x, che puoi utilizzare con qualsiasi editor di testo. Anche se non è richiesto un ambiente di sviluppo integrato (IDE), per praticità, ti consigliamo di utilizzare uno dei seguenti IDE:
  8. È necessaria un'applicazione per inviare richieste all'API di esempio. Questo tutorial fornisce un esempio utilizzando Invoke-WebRequest, che è supportato in PowerShell 3.0 e versioni successive.

  9. Scarica l'interfaccia a riga di comando di Google Cloud.
  10. Aggiorna l'interfaccia a riga di comando gcloud e installa i componenti endpoint.
    gcloud components update
  11. Assicurati che l'interfaccia a riga di comando di Google Cloud (gcloud) sia autorizzata ad accedere ai tuoi dati e servizi su Google Cloud:
    gcloud auth login
    Seleziona un account nella nuova scheda del browser che si apre.
  12. Imposta il progetto predefinito sul tuo ID progetto.
    gcloud config set project YOUR_PROJECT_ID

    Sostituisci YOUR_PROJECT_ID con l'ID progetto di Google Cloud. Se hai altri progetti Google Cloud e vuoi utilizzare gcloud per gestirli, consulta la sezione sulla gestione delle configurazioni dell'interfaccia a riga di comando gcloud.

  13. Seleziona l'area geografica in cui vuoi creare la tua applicazione App Engine. Esegui questo comando per ottenere un elenco di aree geografiche:
    gcloud app regions list
  14. Creare un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con l'ID progetto di Google Cloud e YOUR_REGION con l'area geografica in cui vuoi creare l'applicazione App Engine.
      gcloud app create \
      --project=YOUR_PROJECT_ID \
      --region=YOUR_REGION
    

Recupera il codice di esempio

Per scaricare l'API di esempio:

  1. Scarica il codice campione come file ZIP.

  2. Estrai il file ZIP e passa alla directory dotnet-docs-samples-master\endpoints\getting-started.

  3. Apri GettingStarted.sln con Visual Studio oppure utilizza il tuo editor preferito per modificare i file nella directory endpoints\getting-started\src\IO.Swagger.

Configurazione di Endpoints

Il codice di esempio include il file di configurazione di OpenAPI, openapi-appengine.yaml, basato sulla specifica OpenAPI v2.0.

Per configurare endpoint:
  1. Nella directory del codice di esempio, apri il file di configurazione openapi-appengine.yaml.
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "YOUR-PROJECT-ID.appspot.com"
    

    Tieni presente quanto segue:

    • Nell'esempio di configurazione vengono visualizzate le linee vicino al campo host, che devi modificare. Per eseguire il deployment di openapi-appengine.yaml in endpoint, è necessario il documento OpenAPI completo.
    • L'esempio openapi-appengine.yaml contiene una sezione per la configurazione dell'autenticazione non necessaria per questo tutorial. Non devi configurare le righe con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
    • OpenAPI è una specifica indipendente dal linguaggio. Lo stesso file openapi-appengine.yaml è nell'esempio getting-started in ogni repository GitHub per ogni linguaggio, per praticità.
  2. Nella riga con il campo host, sostituisci YOUR-PROJECT-ID con l'ID progetto di Google Cloud. Ad esempio:
    host: "example-project-12345.appspot.com"
    

Endpoints utilizza il testo configurato nel campo host come nome del servizio. Quando esegui il deployment dell'API nel backend App Engine, viene creata automaticamente una voce DNS con un nome nel formato YOUR-PROJECT-ID.appspot.com.

Per informazioni sui campi nel documento OpenAPI richiesto da Endpoints, consulta la sezione Configurazione degli endpoint.

Eseguire il deployment della configurazione di Endpoints

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

Per eseguire il deployment della configurazione degli endpoint:

  1. Assicurati di essere nella directory endpoints/getting-started.
  2. Carica la configurazione e crea un servizio gestito:
    gcloud endpoints services deploy openapi-appengine.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-appengine.yaml. Service Management configura il servizio in base alle impostazioni nel file openapi-appengine.yaml. Quando apporti modifiche a openapi-appengine.yaml, devi eseguire nuovamente il deployment del file per aggiornare il servizio endpoint.

Durante la creazione e la configurazione del servizio, Service Management trasmette informazioni al terminale. Puoi ignorare gli avvisi relativi ai percorsi nel file openapi-appengine.yaml che non richiedono una chiave API. Una volta completata la configurazione del servizio, Gestione servizi visualizza un messaggio con l'ID e il nome del servizio, simile al seguente:

Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]

Nell'esempio precedente, 2017-02-13r0 è l'ID configurazione del servizio e example-project-12345.appspot.com è il servizio endpoint. L'ID configurazione servizio è costituito da un timestamp, seguito da un numero di revisione. Se esegui nuovamente il deployment del file openapi-appengine.yaml lo stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoint >Servizi in Google Cloud Console.

Se ricevi 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'attivazione dei seguenti servizi Google:
Nome Titolo
servicemanagement.googleapis.com API Service Management
servicecontrol.googleapis.com API Service Control
endpoints.googleapis.com Google Cloud Endpoints

Nella maggior parte dei casi, il comando gcloud endpoints services deploy abilita questi servizi obbligatori. 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 disabilitati esplicitamente.

Utilizza il seguente comando per confermare che i servizi richiesti siano abilitati:

gcloud services list

Se i servizi richiesti non sono elencati, attivali:

gcloud services enable servicemanagement.googleapis.com
gcloud 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 in Cloud Console. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Service name (Nome servizio).

  • Per OpenAPI, ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo name 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 utilizzato per il backend dell'API. Questa sezione ti spiega come eseguire il deployment dell'API di esempio e di ESP in App Engine.

Per eseguire il deployment del backend dell'API:

  1. Apri il file endpoints/getting-started/src/IO.Swagger/app.yaml e aggiungi il nome del servizio:
  2. endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
      # previously run the deploy command, you can list your existing configuration
      # ids using the 'configs list' command as follows:
      # 'gcloud endpoints configs list --service=[PROJECT-ID].appspot.com'
      # where [PROJECT-ID].appspot.com is your Endpoints service name.
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed
    

    Sostituisci ENDPOINTS-SERVICE-NAME con il nome del tuo servizio Endpoints. Si tratta dello stesso nome che hai configurato nel campo host del documento OpenAPI. Ad esempio:

    endpoints_api_service:
      name: example-project-12345.appspot.com
      rollout_strategy: managed
    

    L'opzione rollout_strategy: managed configura ESP in modo che utilizzi la configurazione del servizio più recente di cui è stato eseguito il deployment. Quando specifichi questa opzione, fino a cinque minuti dopo aver eseguito il deployment di una nuova configurazione di servizio, ESP rileva la modifica e inizia automaticamente a utilizzarla. Ti consigliamo di specificare questa opzione invece di un ID di configurazione specifico.

  3. Salva il file app.yaml.
  4. Poiché la sezione endpoints_api_service è inclusa nel file app.yaml, il comando gcloud app deploy esegue il deployment e configura ESP in un container separato nell'ambiente flessibile di App Engine. Tutto il traffico delle richieste viene instradato tramite ESP e invia proxy alle richieste e alle risposte da e verso il container che esegue il codice del server di backend.

  5. Assicurati di essere nella directory endpoints/getting-started, ovvero dove si trova il file di configurazione di openapi-appengine.yaml.
  6. Esegui il deployment dell'API e dell'ESP di esempio in App Engine:
  7.     dotnet restore
        dotnet publish
        gcloud app deploy src\IO.Swagger\bin\Debug\netcoreapp2.0\publish\app.yaml
    

    Il comando gcloud app deploy crea un record DNS nel formato YOUR_PROJECT_ID.appspot.com, che puoi utilizzare quando invii richieste all'API. Ti consigliamo di attendere qualche minuto prima di inviare le richieste alla tua API mentre App Engine viene completamente inizializzato.

Se ricevi un messaggio di errore, consulta Risoluzione dei problemi del deployment flessibile di App Engine.

Per ulteriori informazioni, consulta la sezione Deployment del backend delle API.

Invia richieste all'API

Dopo aver eseguito il deployment dell'API di esempio, puoi inviarle richieste.

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.

  1. Nello stesso progetto Google Cloud che hai utilizzato per l'API, crea una chiave API nella pagina delle credenziali. Se vuoi creare una chiave API in un progetto Google Cloud diverso, vedi Abilitare un'API nel tuo progetto Google Cloud.

    Vai alla pagina Credenziali

  2. Fai clic su Crea credenziali, quindi 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: $Env:ENDPOINTS_KEY="AIza..."

Invia la richiesta

  1. In PowerShell, imposta una variabile di ambiente per l'URL del tuo progetto App Engine. Sostituisci YOUR_PROJECT_ID con l'ID progetto Google Cloud.

    $Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"

  2. Testa una richiesta HTTP utilizzando le variabili di ambiente ENDPOINTS_HOST e ENDPOINTS_KEY impostate in precedenza:

    Invoke-WebRequest "$ENDPOINTS_HOST/echo?key=$ENDPOINTS_KEY" `
      -Body '{"message": "hello world"}' -Method POST `
      -ContentType "application/json"
    

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 che segue gli schizzi in sospeso. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, vedi Invoke-WebRequest nella documentazione di Microsoft.

L'API fa eco sul messaggio che lo invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta corretta, consulta la sezione Risolvere gli errori di risposta.

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

Monitora l'attività dell'API

  1. Visualizza i grafici delle attività per l'API nella pagina Endpoint.

    Vai alla pagina Servizi di endpoint

    Potrebbero essere necessari alcuni minuti prima che la richiesta venga riportata nei grafici.

  2. Esamina i log delle richieste relativi alla tua API nella pagina Esplora log.

    Vai alla pagina Esplora log

Creazione di un portale per 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 ulteriori informazioni, 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.

Per informazioni su come interrompere i servizi utilizzati da questo tutorial, consulta la sezione Eliminare un'API e istanze API.

Passaggi successivi