File dan Konfigurasi yang Diperlukan

Halaman ini menjelaskan file yang harus disertakan dalam API agar dapat menggunakan Cloud Endpoints Frameworks untuk App Engine.

Project Anda harus berisi, minimal, file berikut:

File dan Lokasi Deskripsi
/src/main/java/<packagepath>/<your_api_class>.java File class (atau file, jika Anda menerapkan API di beberapa class) yang berisi API backend.
/src/main/webapp/WEB-INF/appengine-web.xml Deployment descriptor aplikasi web yang diperlukan untuk konfigurasi App Engine.
/src/main/webapp/WEB-INF/web.xml Deployment descriptor aplikasi web Java standar yang memetakan URL ke servlet dan informasi lainnya.

Konten setiap file yang diperlukan ini didokumentasikan di bagian berikut.

File class API

Konten wajib dan opsional dari file class (atau file, jika Anda menggunakan API multi-class) dijelaskan sepenuhnya dalam topik Anotasi Endpoint.

appengine-web.xml

File appengine-web.xml digunakan untuk menentukan konfigurasi lingkungan standar App Engine saat API di-deploy. Lihat Referensi appengine-web.xml untuk mengetahui informasi selengkapnya.

Konten minimum yang diperlukan untuk file ini adalah sebagai berikut:

<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

Anda menggunakan file web.xml untuk mengonfigurasi servlet Endpoints, yang menangani permintaan masuk dan meneruskannya ke layanan backend yang berjalan di App Engine. Servlet Endpoints diperlukan agar API Anda dapat dikelola oleh Cloud Endpoints.

Konten minimum yang diperlukan untuk file ini adalah sebagai berikut:

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

Untuk mengetahui informasi selengkapnya tentang web.xml, lihat Deployment Descriptor: web.xml.