File dan Konfigurasi yang Diperlukan

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

Project Anda minimal harus berisi file berikut:

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

Isi setiap file yang diperlukan ini didokumentasikan di bagian berikut.

File class API

Konten wajib dan opsional dari file class (atau beberapa file, jika Anda menggunakan API multi-class) sepenuhnya dijelaskan 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 informasi selengkapnya.

Isi 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 dapat menggunakan file web.xml untuk mengonfigurasi servlet Endpoint, yang menangani permintaan masuk dan meneruskannya ke layanan backend yang berjalan di App Engine. Servlet Endpoint diperlukan agar API Anda dikelola oleh Cloud Endpoints.

Isi 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 informasi selengkapnya tentang web.xml, lihat Deskripsi Deployment: web.xml.