必要的檔案與設定

本頁說明瞭必須包含在 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 標準 Java 網頁應用程式部署作業描述元將 URL 對應至 Servlet 及其他資訊。

以下各節說明各必要檔案的內容。

API 類別檔案

如需類別檔案 (如果您使用多類別 API 則為多個類別檔案) 的必要和選用內容的完整說明，請瀏覽 Endpoint 註解主題。

appengine-web.xml

appengine-web.xml 檔案是用於在部署 API 時定義 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，其會處理傳入的要求，並將這些要求轉送至在 App Engine 上執行的後端服務。您的 API 需要有 Endpoints servlet 才能由 Cloud Endpoints 管理。

這個檔案所需的最低限度內容如下所示：

<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一文。