Configuration et fichiers requis

Cette page décrit les fichiers à inclure dans l'API pour pouvoir utiliser Cloud Endpoints Frameworks pour App Engine.

Votre projet doit contenir au minimum les fichiers suivants :

Fichier et emplacement	Description
/src/main/java/<packagepath>/<your_api_class>.java	Fichier de classe (ou plusieurs fichiers, si vous mettez en œuvre l'API dans différentes classes) contenant l'API backend.
/src/main/webapp/WEB-INF/appengine-web.xml	Descripteur de déploiement d'applications Web requis pour la configuration d'App Engine.
/src/main/webapp/WEB-INF/web.xml	Descripteur de déploiement d'applications Web Java standard mappant des URL avec des servlets et d'autres informations.

Le contenu de chacun des fichiers requis est détaillé dans les sections suivantes.

Fichier de classe de l'API

Le contenu obligatoire et facultatif du fichier de classe (ou des fichiers, si vous utilisez une API multiclasse) est décrit en détail dans l'article Annotations Endpoints.

appengine-web.xml

Le fichier appengine-web.xml permet de définir la configuration de l'environnement standard App Engine lors du déploiement de l'API. Pour en savoir plus, consultez la page Documentation de référence sur appengine-web.xml.

Le contenu minimum requis pour ce fichier est le suivant :

<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

Le fichier web.xml permet de configurer le servlet Endpoints, qui gère les requêtes entrantes et les transmet au service de backend exécuté sur App Engine. Le servlet Endpoints est requis pour que votre API soit gérée par Cloud Endpoints.

Le contenu minimum requis pour ce fichier est le suivant :

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

Important : Le format d'URL spécifié dans le fichier web.xml définit le chemin de base de l'URL pour l'API. Assurez-vous qu'il se termine par un caractère générique, comme dans /_ah/api/*.

Pour en savoir plus sur le fichier web.xml, consultez la page Descripteur de déploiement : web.xml.