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 Framework Endpoint.
Library dan alat
Framework Cloud Endpoints untuk lingkungan standar App Engine menyediakan library dan alat berikut:
- Framework Endpoints tersedia di
Maven Central Repository
dalam grup
com.google.endpoints
. File.jar
dasar yang diperlukan ada dalam artefakendpoints-framework
. Lihat Javadoc API untuk mengetahui detailnya. - Alat command line
endpoints
(untuk Linux), atauendpoints.cmd
(untuk Windows) yang dapat Anda gunakan untuk membuat paket library klien dan dokumen Discovery, yang memungkinkan aplikasi Android dan jenis aplikasi klien lainnya mengakses API Anda. - Plugin Maven Framework Endpoints
dan
plugin Gradle Framework Endpoints,
yang Anda gunakan untuk membuat 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.
Persyaratan
Untuk menggunakan Framework Endpoint, ikuti proses yang ditampilkan dalam Tutorial.
Anda perlu mengetahui cara mengembangkan klien pilihan Anda, seperti klien web JavaScript, atau klien seluler, seperti Android.
Proses pengembangan
Alur kerja umum untuk mengembangkan aplikasi menggunakan Framework Endpoints adalah:
- Buat project API, lalu tulis kode API Anda.
- Anotasikan API Anda, sehingga class dan library klien dibuat darinya.
- Buat file konfigurasi OpenAPI dan deploy seperti yang dijelaskan dalam Tutorial.
- Secara opsional, uji API Anda secara lokal.
- Men-deploy API.
- Buat library klien.
- 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 diperlukan guna mengonfigurasi, men-deploy, dan menguji API Anda sendiri.
Bermigrasi dari Endpoints versi 1.0
Jika Anda telah mengembangkan backend API menggunakan Endpoints versi sebelumnya, ikuti Panduan migrasi untuk memindahkan aplikasi ke Endpoints versi 2.0.