Deployment e test di un'API

Questa pagina descrive come eseguire il deployment dell'API.

Prima di iniziare

Distribuzione di un'API

Puoi eseguire il deployment dell'API utilizzando App Engine Apache Maven o Gradle. Per eseguire il deployment API in un ambiente App Engine standard di produzione, utilizza il comando il plug-in:

  1. Utilizza il comando per il plug-in:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. Attendi il completamento del deployment.
  3. Invia una richiesta di test all'API di cui è stato eseguito il deployment. Ad esempio, utilizzando curl:

    curl \
        -H "Content-Type: application/json" \
        -X POST \
        -d '{"message": "echo"}' \
        "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"
    

    La tua risposta è simile alla seguente:

    {
      "message": "echo echo"
    }
    

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

Deployment su più versioni dell'applicazione

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

Esecuzione e test dei backend delle API in locale

Per testare l'API localmente:

  1. Crea il progetto nella directory radice del progetto. Ad esempio:

    Maven

    mvn clean package

    Gradle

    gradle clean build
  2. Avvia il server di sviluppo App Engine. Ad esempio:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun
  3. Fai una richiesta API per testare l'API. Ad esempio, se utilizzi curl:

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

Pubblicazione dell'API da un percorso diverso

Per pubblicare l'API da un percorso diverso, modifica il valore nel file web.xml url-pattern nella sezione EndpointsServlet ed esegui nuovamente il deployment dell'API. Per esempio:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

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.