File e configurazione richiesti

Questa pagina descrive i file che devono essere inclusi nell'API per utilizzare Cloud Endpoints Frameworks per App Engine.

Il progetto deve contenere, come minimo, i seguenti file:

File e posizione Descrizione
/src/main/java/<packagepath>/<your_api_class>.java Il file di classe (o i file, se implementi l'API in più classi) contenente l'API di backend.
/src/main/webapp/WEB-INF/appengine-web.xml Il descrittore di deployment dell'app web richiesto per la configurazione di App Engine.
/src/main/webapp/WEB-INF/web.xml Il descrittore di deployment dell'app web Java standard che mappa gli URL ai servlet e ad altre informazioni.

I contenuti di ciascuno di questi file obbligatori sono documentati nelle sezioni seguenti.

Il file di classe API

I contenuti obbligatori e facoltativi del file di classe (o dei file, se utilizzi un' API multi-classe) sono descritti completamente nell'argomento Annotazioni degli endpoint.

appengine-web.xml

Il file appengine-web.xml viene utilizzato per definire la configurazione dell'ambiente standard di App Engine quando viene eseguito il deployment dell'API. Per ulteriori informazioni, consulta la documentazione di riferimento di appengine-web.xml.

I contenuti minimi richiesti per questo file sono i seguenti:

<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
    <runtime>java8</runtime>
    <threadsafe>true</threadsafe>

    <system-properties>
        <property name="java.util.logging.config.file" value="WEB-INF/logging.properties"/>
    </system-properties>
</appengine-web-app>

web.xml

Utilizza il file web.xml per configurare il servlet Endpoints, che gestisce le richieste in entrata e le inoltra al servizio di backend in esecuzione su App Engine. Il servlet Endpoints è necessario per la gestione dell'API da parte di Cloud Endpoints.

I contenuti minimi richiesti per questo file sono i seguenti:

<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    <!-- Wrap the backend with Endpoints Frameworks v2. -->
    <servlet>
        <servlet-name>EndpointsServlet</servlet-name>
        <servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
        <init-param>
            <param-name>services</param-name>
            <param-value>com.example.skeleton.MyApi</param-value>
        </init-param>
    </servlet>
    <!-- Route API method requests to the backend. -->
    <servlet-mapping>
        <servlet-name>EndpointsServlet</servlet-name>
        <url-pattern>/_ah/api/*</url-pattern>
    </servlet-mapping>
</web-app>

Per ulteriori informazioni su web.xml, consulta La documentazione di riferimento del descrittore di deployment: web.xml.