Erforderliche Dateien und Konfiguration

Auf dieser Seite werden die Dateien beschrieben, die in der API enthalten sein müssen, um Cloud Endpoints Frameworks für App Engine verwenden zu können.

Das Projekt muss mindestens die folgenden Dateien enthalten:

Datei und Speicherort	Beschreibung
`/src/main/java/<packagepath>/<your_api_class>.java`	Eine oder mehrere Klassendateien – wenn Sie die API in mehreren Klassen implementieren –, die Ihre Back-End-API enthalten.
`/src/main/webapp/WEB-INF/appengine-web.xml`	Der für die App Engine-Konfiguration erforderliche Bereitstellungsdeskriptor der Web-App.
`/src/main/webapp/WEB-INF/web.xml`	Die Standard-URLs für die Zuordnung des Bereitstellungsdeskriptors der Java-Web-App zu Servlets und anderen Informationen.

Die Inhalte jeder der erforderlichen Dateien werden in den folgenden Abschnitten erläutert.

API-Klassendatei

Eine ausführliche Beschreibung der erforderlichen und optionalen Inhalte der Klassendatei (bzw. Klassendateien bei Verwendung einer API mit mehreren Klassen) finden Sie unter Endpunktanmerkungen.

appengine-web.xml

Die Datei appengine-web.xml wird beim Bereitstellen der API dazu verwendet, die Konfiguration der App Engine-Standardumgebung zu definieren. Weitere Informationen finden Sie in der appengine-web.xml.

Für diese Datei sind mindestens folgende Inhalte erforderlich:

<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

Die Datei web.xml dient zur Konfiguration des Endpoints-Servlets, das eingehende Anfragen verarbeitet und an den Backend-Dienst in App Engine weiterleitet. Das Endpoints-Servlet ist erforderlich, damit Ihre API von Cloud Endpoints verwaltet werden kann.

Für diese Datei sind mindestens folgende Inhalte erforderlich:

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

Weitere Informationen zu web.xml finden Sie unter Deployment-Deskriptor: web.xml .