Introduzione a Cloud Endpoints Frameworks per Python

recupera il codice di esempio

Per clonare l'API di esempio da GitHub:

1. Clona il repository di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples
   

2. Passa alla directory che contiene il codice campione:

   cd python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

Configurazione di Endpoints

Per configurare Endpoints, devi prima installare la libreria Python Endpoints Frameworks. Poi utilizzi uno strumento della libreria Endpoints Frameworks per generare un documento OpenAPI per l'API di esempio. Per consentire a Endpoints di gestire l'API, devi disporre della libreria Endpoints Frameworks e del documento OpenAPI. Per ulteriori informazioni, consulta Aggiunta della gestione API.

Installazione della libreria Endpoints Frameworks

Questa sezione illustra come utilizzare pip di Python per aggiungere la libreria Endpoints Frameworks alla directory del progetto dell'API di esempio.

Per aggiungere la libreria Endpoints Frameworks al sample:

1. Assicurati di trovarti nella directory principale dell'API di esempio, python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo.

2. Crea una sottodirectory /lib nel progetto:

   mkdir lib
   

3. Dalla directory principale dell'esempiopython-docs-samples/appengine/standard/endpoints-frameworks-v2/echo, esegui il comando di installazione:

   pip install --target lib --requirement requirements.txt --ignore-installed
   

   Tieni presente quanto segue:

   • Questo comando pip potrebbe utilizzare GNU Compiler Collection (GCC) per compilare i moduli di estensione. Se utilizzi macOS ed è la prima volta che esegui GCC sul tuo sistema, potresti dover accettare la licenza XCode di Apple. Per farlo, esegui sudo xcodebuild -license.

   • Se sul computer sono installate più versioni di Python, assicurati di utilizzare una versione di pip corrispondente alla versione di Python che stai utilizzando in questo tutorial. Le mancate corrispondenze delle versioni (pip da Python 3.4 mentre si utilizza python da Python 2.7, ad esempio) possono causare errori che possono essere difficili da comprendere. Se necessario, puoi eseguire pip come modulo Python: sostituisci pip nel comando precedente con python -m pip.

   • Se pip non riesce a trovare un pacchetto adatto quando esegui il comando, prova a eseguirne l'upgrade eseguendo pip install --upgrade pip. Al termine dell'upgrade, riprova a eseguire il comando di installazione.

   • In alcune release di Debian e Ubuntu, pip potrebbe non riuscire con DistutilsOptionError. Se visualizzi questo errore, aggiungi il flag --system.

Al termine, la directory lib viene compilata con i file necessari per compilare l'applicazione Endpoints Frameworks.

Generazione del documento OpenAPI

Utilizza uno strumento della libreria Endpoints Frameworks per generare un documento che descriva l'API REST del codice campione.

Per generare il documento OpenAPI:

1. Assicurati di essere nella directory principale dell'esempio:

   python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

2. Genera il documento OpenAPI:

   python lib/endpoints/endpointscfg.py get_openapi_spec main.EchoApi --hostname [YOUR_PROJECT_ID].appspot.com
   

   Sostituisci [YOUR_PROJECT_ID] con l'ID del tuo progetto Google Cloud. Ignora gli avvisi visualizzati. Lo strumento Endpoints genera un documento OpenAPI denominato echov1openapi.json nella directory corrente. Lo strumento Endpoints assegna il nome al file in base al nome e alla versione del servizio specificati nel decoratore @endpoints.api. Per ulteriori informazioni, consulta la sezione Creare l'API.

   Endpoints utilizza il testo specificato nell'argomento hostname come nome del servizio. Il formato del nome YOUR_PROJECT_ID.appspot.com corrisponde alla voce DNS creata automaticamente quando esegui il deployment dell'API nel backend di App Engine. In questo caso, sia il nome del servizio Endpoints sia il nome di dominio completo (FQDN) sono uguali.

Al termine dell'operazione, viene visualizzato il seguente messaggio: OpenAPI spec written to ./echov1openapi.json

esegui il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione di Endpoints, utilizzi Service Infrastructure, la piattaforma di servizi di base di Google, utilizzata da Endpoints e da altri servizi per creare e gestire API e servizi.

Per eseguire il deployment del file di configurazione:

1. Assicurati di essere nella directory principale dell'esempio:

   python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

2. Esegui il deployment del documento OpenAPI generato nella sezione precedente eseguendo il seguente comando:

   gcloud endpoints services deploy echov1openapi.json

   Viene creato un nuovo servizio Endpoints con il nome specificato nell'argomento hostname quando hai eseguito lo strumento Endpoints per generare il documento OpenAPI. Indipendentemente dal nome del servizio Endpoints, quando esegui il deployment dell'API su App Engine viene creato un record DNS utilizzando il formato del nomeYOUR_PROJECT_ID.appspot.com, ovvero il FQDN che utilizzi quando invii richieste all'API.

   Durante la creazione e la configurazione del servizio, Service Management visualizza moltissime informazioni sul terminale. Puoi ignorare tranquillamente gli avvisi sui percorsi presenti in echov1openapi.json che non richiedono una chiave API. Al termine del deployment, viene visualizzato un messaggio simile al seguente:

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

   Nell'esempio precedente, 2017-02-13-r2 è l'ID configurazione del servizio e example-project-12345.appspot.com è il nome del servizio.

   Per ulteriori informazioni, consulta gcloud endpoints services deploy nella documentazione di riferimentogcloud.

Verifica dei servizi richiesti

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 campo name della configurazione degli endpoint gRPC.

Per ulteriori informazioni sui comandi gcloud, consulta Servizi gcloud.

Eseguire il sample localmente

Dopo aver eseguito il deployment della configurazione degli endpoint, puoi eseguire il sample localmente utilizzando il server di sviluppo locale.

1. Assicurati di essere nella directory principale dell'esempio:

   python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

2. Avvia il server di sviluppo locale:

   dev_appserver.py ./app.yaml
   

   Per impostazione predefinita, il server di sviluppo è in ascolto su http://localhost:8080, come indicato nei log della console Google Cloud stampati da dev_appserver.py:

   INFO 2018-01-01 [...] Starting module "default" running at: http://localhost:8080
   

3. Invia una richiesta al server di sviluppo locale:

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    http://localhost:8080/_ah/api/echo/v1/echo

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://localhost:8080/_ah/api/echo/v1/echo").Content

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

{
 "message": "hello world"
}

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 la procedura per eseguire il deployment dell'API di esempio in App Engine.

Per eseguire il deployment del backend dell'API:

1. Visualizza l'ID configurazione del servizio eseguendo il seguente comando:

   gcloud endpoints configs list --service=[YOUR_PROJECT_ID].appspot.com

   Sostituisci [YOUR_PROJECT_ID] con l'ID progetto. Ad esempio:

   gcloud endpoints configs list --service=example-project-12345.appspot.com
   
   

2. Open the app.yaml file in the python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo directory.

   env_variables:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy swagger.json' command.
     ENDPOINTS_SERVICE_NAME: YOUR-PROJECT-ID.appspot.com
     ENDPOINTS_SERVICE_VERSION: 2016-08-01r0