Halaman ini menjelaskan cara menyiapkan lingkungan pengembangan Anda untuk mem-build dan men-deploy API backend menggunakan Framework Cloud Endpoints untuk lingkungan standar App Engine. Halaman ini menggunakan contoh kode kerangka Endpoint Frameworks versi 2.0 untuk menjelaskan software dan komponen dasar yang Anda perlukan untuk memulai.
Sebaiknya gunakan
endpoints-skeleton-archetype
atau hello-endpoints-archetype
yang dijelaskan dalam
Menggunakan Apache Maven dan plugin App Engine (berbasis Google Cloud CLI)
untuk membuat project Endpoints Frameworks versi 2.0 baru.
Untuk mendapatkan pemahaman yang lebih baik tentang langkah-langkah yang diperlukan untuk men-deploy contoh API menggunakan Framework Endpoint, lihat tutorial Mulai menggunakan Framework Endpoint di App Engine.
Sebelum memulai
- Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
-
Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.
-
Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
-
Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.
-
Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
- Catat ID project Google Cloud karena akan diperlukan nanti.
Menginstal dan mengonfigurasi software yang diperlukan
- Jika Anda belum menginstal Java 8, download Java Development Kit (JDK) dari situs Oracle lalu instal.
- Instal Maven atau Gradle:
Maven
- Download Apache Maven versi 3.3.9 atau yang lebih baru
- Instal dan configure Maven untuk lingkungan pengembangan lokal Anda.
Gradle
- Download dan lakukan inisialisasi Google Cloud CLI.
- Jalankan perintah berikut:
- Pastikan bahwa gcloud CLI diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:
gcloud auth login
- Gunakan kredensial default aplikasi:
gcloud auth application-default login
- Instal komponen
app-engine-java
Google Cloud SDK:gcloud components install app-engine-java
- Update ke versi terbaru Google Cloud SDK dan semua komponen:
gcloud components update
- Pastikan bahwa gcloud CLI diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:
- Buat aplikasi App Engine:
-
Tetapkan project default ke project ID Google Cloud Anda:
gcloud config set project YOUR_PROJECT_ID
Ganti
YOUR_PROJECT_ID
dengan project ID Google Cloud Anda. Jika Anda memiliki project Google Cloud lain, dan ingin menggunakangcloud
untuk mengelolanya, lihat Mengelola konfigurasi CLI gcloud. - Pilih region tempat Anda ingin membuat aplikasi App Engine. Lihat Lokasi App Engine untuk mengetahui daftar region.
- Buat aplikasi App Engine.
Ganti
YOUR_PROJECT_ID
dengan project ID Google Cloud Anda danYOUR_REGION
dengan region tempat Anda ingin membuat aplikasi App Engine.gcloud app create \ --project=YOUR_PROJECT_ID \ --region=YOUR_REGION
-
Tetapkan project default ke project ID Google Cloud Anda:
Mendapatkan contoh kerangka Framework Endpoints
Contoh kerangka Framework Endpoint versi 2.0 berisi skrip build yang diperlukan untuk Maven dan Gradle. API ini juga berisi file yang diperlukan untuk mulai membuat API pertama Anda.
Clone repositori contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
Beralihlah ke direktori yang berisi contoh kerangka Framework Endpoint:
cd java-docs-samples/appengine-java8/endpoints-v2-skeleton/
Contoh ini memiliki struktur direktori berikut:
MyApi.java
berisi class kosong yang dapat Anda gunakan untuk mulai menulis API. Lihat contoh echo untuk kode contoh guna membantu Anda memulai.web.xml
adalah file standar yang digunakan untuk mengonfigurasi servlet.appengine-web.xml
menentukan informasi yang diperlukan untuk men-deploy API ke lingkungan standar App Engine menggunakan Java 8.pom.xml
berisi informasi project dan konfigurasi yang digunakan oleh Maven untuk membangun project dan men-deploy API ke App Engine.build.gradle
berisi informasi project dan konfigurasi yang digunakan oleh Gradle untuk membangun project dan men-deploy API ke App Engine.
Mengonfigurasi file build
Bagian ini menjelaskan file pom.xml
Maven dan build.gradle
Gradle
yang disertakan dalam kode contoh. Kecuali untuk memasukkan ID project Google Cloud
agar dapat digunakan dalam nama host, file build siap digunakan untuk
mulai membuat API.
Tentang konfigurasi minimum
Bagian ini menjelaskan konfigurasi minimum yang diperlukan dalam file build Anda.
Maven
Dependensi minimum
Berikut ini dependensi minimum yang diperlukan dalam
pom.xml
untuk memulai:
- Dependensi
endpoints-framework
berisi class yang diperlukan untuk membuat API. - Anda memerlukan <atrack-type="tasks" l10n-attrs-original-order="href,track-type,track-name,track-metadata-position" l10n-encrypted-href="8uk1g2YxVmQFExiHWQoDVLU3uURKQq2GHK/Q1ZkBJNo="internal track-metadata-position="body" track API standar
appengine-api-sdk
- Paket
javax.servlet
standar diperlukan untuk membuat servlet. - Paket
javax.inject
standar diperlukan untuk mendukung injeksi dependensi.
Menerapkan plugin
Plugin berikut diterapkan untuk mengaktifkannya:
maven-war-plugin
memperluas pluginjava
guna menambahkan dukungan untuk menyusun aplikasi web.-
appengine-maven-plugin
diperlukan untuk menjalankan API di App Engine. -
endpoints-framework-maven-plugin
menyediakan tugas dan konfigurasi untuk mem-build project Framework Endpoint.
Gradle
Dependensi plugin
Berikut ini adalah plugin yang diperlukan untuk membangun API:
- Plugin Gradle Endpoints Frameworks digunakan untuk membuat dokumen OpenAPI dan membuat library klien.
- Anda memerlukan plugin App Engine Gradle untuk men-deploy project ke App Engine.
Menerapkan plugin
Plugin berikut diterapkan untuk mengaktifkannya dalam skrip build Gradle Anda:
- Plugin
java
menambahkan langkah-langkah build dan kompilasi khusus Java ke project Anda. - Plugin
war
memperluas pluginjava
guna menambahkan dukungan untuk menyusun aplikasi web. - Plugin
endpoints-framework-server
memberikan dukungan sisi server untuk plugin Gradle Endpoints Frameworks. - Plugin
appengine
diperlukan untuk menjalankan API di App Engine.
Dependensi project
Dependensi berikut digunakan oleh project:
- Dependensi
endpoints-framework
berisi class yang diperlukan untuk membuat API. - App Engine Standard API SDK (
appengine-api-sdk
) diperlukan untuk men-deploy project Anda ke lingkungan standar App Engine. - Paket
javax.servlet
standar diperlukan untuk membuat servlet. - Paket
javax.inject
standar diperlukan untuk mendukung injeksi dependensi.
Menentukan nama host layanan
Endpoints Frameworks menggunakan nama yang kompatibel dengan DNS untuk mengidentifikasi layanan secara unik. Karena ID project Google Cloud dijamin unik secara global, Anda harus menggunakan project ID Google Cloud sebagai bagian dari nama layanan API.
Anda harus menambahkan project ID Google Cloud ke file build untuk mengonfigurasi nama host layanan Anda. Nama host harus dalam format berikut:
YOUR_PROJECT_ID.appspot.com
Saat Anda men-deploy API ke App Engine, entri DNS dengan nama dalam format YOUR_PROJECT_ID.appspot.com
dibuat secara otomatis. Nama host adalah nama layanan Cloud Endpoints dan nama domain yang Anda gunakan untuk mengirim permintaan ke API Anda.
Maven
Di kolom hostname
, ganti
YOUR_PROJECT_ID
dengan project ID Google Cloud
Anda.
Gradle
Tetapkan variabel projectID
ke project ID Google Cloud Anda. Contoh: def projectId = 'example-project-12345'
Mengonfigurasi servlet Endpoints
Servlet Endpoint menangani permintaan masuk dan meneruskannya ke layanan backend yang berjalan di App Engine. Servlet Endpoint diperlukan agar API Anda dikelola oleh Endpoint.
Untuk informasi selengkapnya tentang web.xml
, lihat Deskripsi deployment: web.xml
.
Mengonfigurasi deployment App Engine
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.
Langkah selanjutnya
- Tulis dan anotasikan kode API backend Anda.
- Pelajari lebih lanjut anotasi.
- Menambahkan pengelolaan API.
- Deploy dan uji API Anda.
- Pelajari lebih lanjut parameter dan jenis nilai yang ditampilkan yang didukung.