Configuração e arquivos exigidos

Nesta página, descrevemos os arquivos que precisam ser incluídos na API para usar o Cloud Endpoints Frameworks para o App Engine.

Seu projeto precisa conter, no mínimo, os seguintes arquivos:

Arquivo e localização	Descrição
/src/main/java/<packagepath>/<your_api_class>.java	O arquivo de classe (ou arquivos, se você implementar a API em várias classes) com a API de back-end.
/src/main/webapp/WEB-INF/appengine-web.xml	O descritor de implantação do app da Web necessário para a configuração do App Engine.
/src/main/webapp/WEB-INF/web.xml	O descritor de implantação do app da Web Java padrão que mapeia os URLs para servlets e outras informações.

O conteúdo de cada um desses arquivos necessários está documentado nas seções seguintes.

O arquivo de classe da API

Os conteúdos obrigatórios e opcionais do arquivo de classe (ou arquivos, se você usa uma API multiclasse) foram descritos detalhadamente no tópico Anotações do Endpoints.

appengine-web.xml

O arquivo appengine-web.xml é usado para definir a configuração do ambiente padrão do App Engine quando a API é implantada. Para mais informações, consulte a Referência de appengine-web.xml.

O conteúdo básico mínimo necessário para esse arquivo é o seguinte:

<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

Use o arquivo web.xml para configurar o servlet Endpoints, que processa as solicitações de entrada e as encaminha ao serviço de back-end em execução no App Engine. O servlet Endpoints é necessário para que a API seja gerenciada pelo Cloud Endpoints.

O conteúdo básico mínimo necessário para esse arquivo é o seguinte:

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

Importante: o padrão de URL especificado no arquivo web.xml define o caminho base do URL para a API. O padrão precisa terminar com um caractere curinga, como em /_ah/api/*.

Para mais informações sobre web.xml, consulte Descritor de implantação: web.xml.