Deployment e test di un'API

In questa pagina viene descritto come eseguire il deployment dell'API.

Prima di iniziare

Deployment dell'API in produzione

Per eseguire il deployment di un'API:

  1. Imposta la variabile di ambiente ENDPOINTS_GAE_SDK sul percorso della cartella dell'SDK App Engine: Path_to_Cloud_SDK/platform/google_appengine.

    Sostituisci Path_to_Cloud_SDK con l'output del seguente comando:

     gcloud info --format="value(installation.sdk_root)"
    
  2. Esegui questo comando nella directory principale dell'API:

     gcloud app deploy
    

    Attendi qualche momento per la riuscita del deployment, ignorando i messaggi di avviso. Al termine del deployment, viene visualizzato un messaggio simile al seguente:

    File upload done.
    Updating service [default]...done.
    
  3. Conferma il deployment correttamente inviando una richiesta di test all'API, ad esempio:

    curl --request POST \
       --header "Content-Type: application/json" \
       --data '{"content":"echo"}' \
       https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2
    

    Sostituisci PROJECT_ID con l'ID progetto e echo con il nome dell'API.

    I risultati sono:

    {
     "content": "echo echo"
    }
    

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

Deployment su più versioni dell'app

Per informazioni su come eseguire il controllo delle versioni delle API e su come eseguire il deployment nelle versioni, consulta Gestire il controllo delle versioni delle API

Test di un'API in locale

Puoi utilizzare il server di sviluppo locale di App Engine per testare l'API in locale. Per ulteriori informazioni sul server di sviluppo locale, consulta la pagina relativa all'utilizzo del server di sviluppo locale.

Per eseguire l'API localmente:

  1. Dalla directory radice del progetto, avvia il server di sviluppo App Engine:

    dev_appserver.py YOUR_PROJECT_DIR
    
  2. Esegui curl per effettuare una richiesta API, ad esempio:

     curl --request POST \
        --header "Content-Type: application/json" \
        --data '{"message":"echo"}' \
        "${HOST}/_ah/api/echo/v1/echo?n=2"
    

Aggiunta della gestione delle API

Endpoints Frameworks fornisce funzionalità di gestione delle API come:

Affinché l'API venga gestita da Endpoints Frameworks, devi generare ed eseguire il deployment di un documento OpenAPI che descriva l'API, come descritto in Aggiungere la gestione delle API.