Tentang Framework Cloud Endpoints untuk Java

Halaman ini menjelaskan library dan alat serta memberikan informasi lainnya untuk membantu Anda mulai menggunakan Framework Endpoints untuk Java. Lihat Tentang Framework Endpoint untuk mengetahui ringkasan arsitektur Endpoints Frameworks.

Library dan alat

Framework Cloud Endpoints untuk lingkungan standar App Engine menyediakan library dan alat berikut:

• Endpoints Frameworks tersedia di Maven Central Repository dalam grup com.google.endpoints. File .jar dasar yang diperlukan ada dalam artefak endpoints-framework. Lihat API Javadoc untuk mengetahui detailnya.
• Alat command line endpoints (untuk Linux), atau endpoints.cmd (untuk Windows) yang dapat Anda gunakan untuk membuat paket library klien dan dokumen Discovery, yang memungkinkan aplikasi Android dan jenis aplikasi klien lainnya untuk mengakses API Anda.
• Plugin Maven Endpoint Frameworks dan plugin Gradle Endpoint Frameworks, yang Anda gunakan untuk menghasilkan hal berikut:
  • Paket library klien dan dokumen Discovery.
  • File konfigurasi OpenAPI, yang Anda gunakan jika menginginkan fungsi pengelolaan API seperti pemantauan, logging, dan validasi kunci API.

Catatan: Karena backend API adalah aplikasi App Engine, developer dapat menggunakan layanan dan fitur yang tersedia di lingkungan standar App Engine, seperti Datastore, Cloud Storage, Email, Pengambilan URL, Task queue, dan sebagainya. Dan terakhir, dengan menggunakan App Engine untuk backend, developer terbebas dari tugas admin sistem, load balancing, penskalaan, dan pemeliharaan server.

Persyaratan

Untuk menggunakan Framework Endpoint, ikuti proses yang ditunjukkan dalam Tutorial.

Anda perlu mengetahui cara mengembangkan klien pilihan Anda, seperti klien web JavaScript, atau klien seluler, seperti Android.

Catatan: Anda tidak dapat memanggil Cloud Endpoints API langsung dari task queue push atau cron job.

Proses pengembangan

Alur kerja umum untuk mengembangkan aplikasi menggunakan Framework Endpoint adalah:

1. Buat project API, lalu tulis kode API Anda.
2. Beri anotasi pada API Anda agar class dan library klien dihasilkan dari API tersebut.
3. Buat file konfigurasi OpenAPI dan deploy seperti yang dijelaskan dalam Tutorial.
4. Jika ingin, uji API Anda secara lokal.
5. Men-deploy API.
6. Buat library klien.
7. Tulis aplikasi klien Anda menggunakan library klien saat melakukan panggilan ke API.

Memulai

Untuk memulai, ikuti Tutorial untuk mengonfigurasi, men-deploy, dan mengirim permintaan ke API contoh. Kemudian, kembali ke bagian ini untuk mengetahui informasi yang Anda perlukan untuk mengonfigurasi, men-deploy, dan menguji API Anda sendiri.

Bermigrasi dari Endpoint versi 1.0

Jika Anda sudah mengembangkan backend API menggunakan Endpoint versi sebelumnya, ikuti Panduan migrasi untuk memindahkan aplikasi Anda ke Endpoint versi 2.0.