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

---

Questo tutorial mostra come configurare ed eseguire il deployment l'API .NET Core di esempio Extensible Service Proxy (ESP) in esecuzione su un'istanza Ambiente flessibile di App Engine. L'API REST del codice campione viene descritta utilizzando il comando Specifica OpenAPI. Il tutorial ti mostra anche come creare chiave API e utilizzarla nelle richieste a l'API.

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

Obiettivi

Segui il seguente elenco di attività di alto livello durante il tutorial. Tutti per inviare correttamente le richieste all'API.

1. Configurare un progetto Google Cloud, installare il software richiesto e creerai un'applicazione App Engine. Consulta: Prima di iniziare.
2. Scarica il codice campione. Consulta Recupero del codice di esempio.
3. Configura il file openapi-appengine.yaml, utilizzato per configurare Endpoints. Consulta Configurare Endpoints.
4. Esegui il deployment della configurazione di Endpoints per creare Servizio Endpoints. Consulta Eseguire il deployment della configurazione di Endpoints.
5. Esegui il deployment dell'API di esempio e di ESP in App Engine. Consulta: Deployment del backend dell'API.
6. Invia una richiesta all'API. Consulta: Invio di una richiesta all'API.
7. Monitora l'attività dell'API. Consulta Monitoraggio dell'attività dell'API.
8. Evita che al tuo account Google Cloud vengano addebitati costi. Consulta: Esegui la pulizia.

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

• App Engine
• Endpoints

Per generare una stima dei costi basata sull'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud potrebbero essere idonei per una prova gratuita.

Una volta completate le attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la pagina Pulizia.

Prima di iniziare

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure 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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Prendi nota dell'ID progetto perché sarà necessario in seguito.
7. Questo tutorial richiede l'SDK.NET Core 2.x, che puoi da usare con qualsiasi editor di testo. Sebbene un ambiente di sviluppo integrato (IDE) non è obbligatorio. Per praticità, ti consigliamo di utilizzare uno dei seguenti IDE:
   • Visual Studio Code, che funziona su macOS, Linux e Windows. Se utilizzare Visual Studio Code, devi installare anche .NET Core 2.x.
   • Visual Studio 2017 per Windows, che include .NET Core 2.x. Se Visual Studio 2017, consigliamo di usare plug-in di Google Cloud Tools for Visual Studio, che integra il deployment di App Engine all'interno dell'IDE.
   • Visual Studio per Mac, che include .NET Core 2.x.

8. Devi disporre di un'applicazione per inviare richieste all'API di esempio. Questo tutorial fornisce un esempio di utilizzo Invoke-WebRequest, ovvero supportato in PowerShell 3.0 e versioni successive.

9. Scarica Google Cloud CLI.
10. Aggiorna gcloud CLI e installa Endpoints componenti.

    gcloud components update

11. 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.
12. Imposta il progetto predefinito sul tuo ID progetto.

    gcloud config set project YOUR_PROJECT_ID

    Sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto Google Cloud. Se hai altri progetti Google Cloud e vuoi utilizzare gcloud consulta Gestione di gcloud CLI configurazioni.

13. Seleziona la regione in cui vuoi creare l'applicazione App Engine. Esegui il comando seguente per ottenere un elenco di regioni:

    gcloud app regions list

14. Creare un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con il tuo Google Cloud l'ID progetto YOUR_REGION con la regione in cui vuoi che venga Applicazione App Engine creata.

      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 di esempio come file ZIP.

2. Estrai il file ZIP e modifica il Directory dotnet-docs-samples-master\endpoints\getting-started.

3. Apri GettingStarted.sln con Visual Studio o 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 OpenAPI,openapi-appengine.yaml, basato sulla specifica OpenAPI 2.0.

Per configurare gli 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:

   • L'esempio di configurazione mostra le righe vicino al campo host che devi modificare. Per eseguire il deployment di openapi-appengine.yaml in Endpoints, è 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 linee con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
   • OpenAPI è una specifica indipendente dal linguaggio. Uguale openapi-appengine.yaml file si trova nel getting-started campione in repository GitHub di ogni linguaggio.

2. Nella riga con il campo host, sostituisci YOUR-PROJECT-ID con l'ID del tuo progetto 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, Voce DNS con un nome nel formato YOUR-PROJECT-ID.appspot.com viene creata automaticamente.

Per informazioni sui campi nel documento OpenAPI che Per gli endpoint è necessario, consulta Configurazione Endpoint.

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

Durante la creazione e la configurazione del servizio, Service Management invia informazioni al terminale. Puoi ignorare tranquillamente gli avvisi relativi ai percorsi nel file openapi-appengine.yaml che non richiedono una chiave API. Al termine della configurazione del servizio, Service Management visualizza con l'ID configurazione del servizio e il nome del servizio, simili seguenti:

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

Nell'esempio precedente, 2017-02-13r0 è il servizio dell'ID configurazione, mentre example-project-12345.appspot.com è Servizio Endpoints. L'ID configurazione del servizio è costituito da un data e ora seguita da un numero di revisione. Se esegui il deployment Di nuovo openapi-appengine.yaml file nello stesso giorno, la revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoints > Servizi della console Google Cloud.

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

Verifica dei servizi richiesti

Come minimo, Endpoints ed ESP richiedono 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 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, includono questi servizi.

• Hai eseguito il deployment della configurazione di Endpoints in un progetto Google Cloud esistente in cui questi servizi sono stati disattivati esplicitamente.

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

gcloud services list

Se non vedi elencati i servizi richiesti, abilitali:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Abilita anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare il ENDPOINTS_SERVICE_NAME puoi:

• Dopo aver eseguito il deployment della configurazione di Endpoints, vai alla pagina Endpoints nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Nome servizio.

• Per OpenAPI, ENDPOINTS_SERVICE_NAME è quello che hai specificato nel campo host della specifica OpenAPI. Per gRPC, il valore ENDPOINTS_SERVICE_NAME è quello specificato nel campo name della configurazione degli endpoint gRPC.

Per ulteriori informazioni sui comandi gcloud, consulta gcloud servizi.

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. Questo illustra 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:
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 nella 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 di cui è stato eseguito il deployment più recente. Quando specifichi questa opzione, fino a 5 minuti dopo aver eseguito il deployment di una nuova configurazione del servizio, ESP rileva la modifica e inizia a utilizzarla automaticamente. Me consigliamo di specificare questa opzione anziché un ID configurazione specifico per ESP.

2. Salva il file app.yaml.

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

3. Assicurati di essere nella endpoints/getting-starteddirectory, dove si trova il file di configurazione di openapi-appengine.yaml individuarlo.
4. Esegui il deployment dell'API e di ESP di esempio in App Engine:

    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 nell'interfaccia formato YOUR_PROJECT_ID.appspot.com, che utilizzi quando inviate richieste all'API. Ti consigliamo di attendere qualche minuto prima di inviare richieste all'API durante l'inizializzazione completa di App Engine.

Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di deployment in ambienti flessibili di App Engine.

Per ulteriori informazioni, consulta Eseguire il deployment del backend dell'API.

invia richieste all'API

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

Creare una chiave API e impostare una variabile di ambiente

Il codice campione richiede una chiave API. Per semplificare la richiesta, puoi impostare di variabile di ambiente per la chiave API.

1. Nello stesso progetto Google Cloud che hai utilizzato per l'API, crea una chiave API nella Credenziali API. Se vuoi creare una chiave API in un altro progetto Google Cloud, consulta Abilitazione di un'API nel 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. Incolla la chiave API sul computer locale per assegnarla a un ambiente variabile: $Env:ENDPOINTS_KEY="AIza..."

Invia la richiesta

1. In PowerShell, imposta una variabile di ambiente per l'URL del progetto App Engine. Sostituisci YOUR_PROJECT_ID con 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 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.

L'API restituisce il messaggio che le hai inviato e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta positiva, consulta Risolvere i problemi relativi alle risposte.

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

Nota: se vuoi farci sapere cosa ti è piaciuto di questo tutorial, non esitare a inviare un feedback nella parte inferiore di questa pagina. Il tuo feedback ci aiuta a migliorare questi tutorial.
Se hai visualizzato un messaggio di errore, partecipa al gruppo Google google-cloud-endpoints e comunicaci cosa non ha funzionato. Questo gruppo riceve risposte da altri utenti di Endpoints e dai tecnici di Google, che lo monitorano.

monitora l'attività dell'API

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

   Vai alla pagina dei servizi Endpoints

   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

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.

Consulta la sezione Eliminare un'API e le relative istanze per informazioni su come interrompere i servizi utilizzati da questo tutorial.

Passaggi successivi

• Condividere l'API con un altro sviluppatore
• Scopri di più sull'autenticazione
• Scopri di più sulle opzioni di assistenza dalla community