Deployment e test di un'API

Questa pagina descrive come eseguire il deployment dell'API.

Prima di iniziare

Eseguire il deployment dell'API in produzione

Per eseguire il deployment di un'API:

  1. Imposta la variabile di ambiente ENDPOINTS_GAE_SDK sul percorso della directory 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 il seguente comando nella directory principale dell'API:

     gcloud app deploy

    Attendi qualche istante affinché il deployment vada a buon fine, 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 buon esito del deployment 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 del tuo progetto e echo con il nome dell'API.

    I risultati sono:

    {
 "content": "echo echo"
}

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

Deployment in più versioni dell'app

Per informazioni su come eseguire il controllo delle versioni dell'API e su come eseguire il deployment nelle versioni, consulta Gestione del controllo delle versioni dell'API

Testare un'API in locale

Puoi utilizzare il server di sviluppo locale App Engine per testare la tua API localmente. Per saperne di più sul server di sviluppo locale, consulta Utilizzare il server di sviluppo locale.

Per eseguire l'API localmente:

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

    dev_appserver.py YOUR_PROJECT_DIR

  2. Esegui curl per inviare 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é la tua API venga gestita dai framework Endpoints, devi generare e implementare un documento OpenAPI che la descriva, come descritto in Aggiunta della gestione delle API.