Configuración y archivos necesarios

En esta página se describen los archivos que se deben incluir en la API para usar Cloud Endpoints Frameworks para App Engine.

Tu proyecto debe contener, como mínimo, los siguientes archivos:

Archivo y ubicación Descripción
/src/main/java/<packagepath>/<your_api_class>.java El archivo de clase (o los archivos de clase, si implementas tu API en varias clases) que contiene tu API de backend.
/src/main/webapp/WEB-INF/appengine-web.xml Descriptor de implementación de la aplicación web necesario para la configuración de App Engine.
/src/main/webapp/WEB-INF/web.xml El descriptor de despliegue estándar de la aplicación web Java que asigna URLs a servlets y otra información.

El contenido de cada uno de estos archivos obligatorios se describe en las siguientes secciones.

El archivo de clase de la API

El contenido obligatorio y opcional del archivo de clase (o archivos, si usas una API de varias clases) se describe por completo en el tema Anotaciones de endpoint.

appengine-web.xml

El archivo appengine-web.xml se usa para definir la configuración del entorno estándar de App Engine cuando se despliega la API. Consulta más información en la referencia de appengine-web.xml.

El contenido mínimo necesario para este archivo es el siguiente:

<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

El archivo web.xml se usa para configurar el servlet de Endpoints, que gestiona las solicitudes entrantes y las reenvía al servicio de backend que se ejecuta en App Engine. El servlet de Endpoints es necesario para que tu API esté gestionada por Cloud Endpoints.

El contenido mínimo necesario para este archivo es el siguiente:

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

Para obtener más información sobre web.xml, consulta El descriptor de implementación: web.xml.