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 della tua API utilizzando i plug-in Apache Maven o Gradle per App Engine. Per eseguire il deployment dell'API in un ambiente standard di produzione di App Engine, utilizza il comando per il tuo plug-in:

  1. Utilizza il comando per il tuo 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 risposta è simile alla seguente:

    {
  "message": "echo echo"
}

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

Deployment su più versioni dell'applicazione

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

Esecuzione e test dei backend API in locale

Per testare l'API localmente:

  1. Crea il progetto nella directory principale 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. Esegui una richiesta API per testare l'API. Ad esempio, utilizzando curl:

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

Gestione dell'API da un percorso diverso

Per pubblicare l'API da un percorso diverso, nel file web.xml, modifica url-pattern nella sezione EndpointsServlet e esegui nuovamente il deployment dell'API. Ad 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 da Endpoints Frameworks, devi generare e implementare un documento OpenAPI che descriva la tua API, come descritto in Aggiunta della gestione API.