必需的文件和配置

本页面介绍了必须包含在 API 中的文件，才能使用适用于 App Engine 的 Cloud Endpoints Frameworks。

您的项目必须至少包含以下文件：

文件和位置	说明
`/src/main/java/<packagepath>/<your_api_class>.java`	包含后端 API 的类文件（或多个文件，如果您跨多个类实现 API）。
`/src/main/webapp/WEB-INF/appengine-web.xml`	App Engine 配置所需的网页应用部署描述符。
`/src/main/webapp/WEB-INF/web.xml`	将网址映射到 Servlet 及其他信息的标准 Java 网页应用部署描述符。

以下各部分记录了每个所需文件的内容。

API 类文件

如需查看该类文件（如果您使用多类 API，则为多个类文件）的必需内容和可选内容的完整说明，请参阅端点注释主题。

appengine-web.xml

在部署 API 时，appengine-web.xml 文件用于定义 App Engine 标准环境配置。如需了解更多信息，请参阅 appengine-web.xml 参考文档。

该文件至少需要以下内容：

<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

您可以使用 web.xml 文件来配置 Endpoints servlet，该 servlet 处理传入的请求并将其转发到在 App Engine 上运行的后端服务。为了实现由 Cloud Endpoints 管理您的 API，您必须使用 Endpoints Servlet。

该文件至少需要以下内容：

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

如需详细了解 web.xml，请参阅部署描述符：web.xml。