Deployment e test di un'API

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

Prima di iniziare

Configura l'ambiente di programmazione.
Crea un'API e annotala.

Distribuzione di un'API

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

Utilizza il comando per il plug-in:
Maven
```
mvn appengine:deploy
```
Gradle
```
gradle appengineDeploy
```
Attendi il completamento del deployment.

Invia una richiesta di test all'API di cui hai eseguito il deployment. Ad esempio, se utilizzi 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 corretta, consulta la sezione Risoluzione dei problemi relativi agli errori di risposta.

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 Gestire il controllo delle versioni delle API

Esecuzione e test dei backend API in locale

Per testare l'API in locale:

Crea il progetto nella directory radice del progetto. Ad esempio:
Maven
```
mvn clean package
```
Gradle
```
gradle clean build
```
Avviare il server di sviluppo di App Engine. Ad esempio:
Maven
```
mvn appengine:run
```
Gradle
```
gradle appengineRun
```

Effettua 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"

Gestione dell'API da un percorso diverso

Per pubblicare l'API da un percorso diverso, nel file web.xml modifica il valore url-pattern nella sezione EndpointsServlet ed 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é 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.