Plugin Gradle Framework Endpoints

Plugin Gradle Endpoints Framework menyediakan tugas dan konfigurasi untuk mem-build dan menghubungkan Endpoints Framework untuk project App Engine. Plugin ini menyediakan dukungan sisi server dan sisi klien. Plugin sisi server menghasilkan dokumen Discovery dan spesifikasi OpenAPI dari project Java Endpoints Framework dan library klien yang dianotasi. Plugin sisi klien menghasilkan library klien saat dokumen discovery tersedia.

Dependensi plugin

Tambahkan dependensi plugin Gradle Framework Endpoints menggunakan cuplikan berikut di build.gradle Anda. Cuplikan berikut mengambil dependensi dari Maven Central:

classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2'

Plugin sisi server

Tambahkan plugin Gradle Endpoints Framework sisi server menggunakan cuplikan berikut di build.gradle:

apply plugin: 'com.google.cloud.tools.endpoints-framework-server'

Tetapkan konfigurasi sisi server di build.gradle Anda dengan penutupan endpointsServer:

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

Tugas dan properti sisi server

Tugas berikut hanya ditampilkan untuk sisi server.

endpointsClientLibs

Tugas ini menghasilkan library klien endpoint berdasarkan class layanan.

Anda dapat menggunakan properti berikut:

Properti	Deskripsi
serviceClasses	Daftar class layanan (class endpoint), ini dapat disimpulkan dari `web.xml`.
clientLibDir	Direktori output untuk library klien yang dihasilkan.
hostname	Untuk menetapkan URL root untuk library klien yang dihasilkan. Misalnya, menggunakan `hostname = myapp.appspot.com` akan menghasilkan URL root default `https://myapp.appspot.com/_ah/api`.

endpointsDiscoveryDocs

Tugas ini menghasilkan dokumen penemuan berdasarkan class layanan.

Anda dapat menggunakan properti berikut:

Properti	Deskripsi
serviceClasses	Daftar class layanan (class endpoint), ini dapat disimpulkan dari `web.xml`.
hostname	Untuk menetapkan URL root untuk dokumen penemuan yang dihasilkan. Misalnya, menggunakan `hostname = myapp.appspot.com` akan menghasilkan URL root default `https://myapp.appspot.com/_ah/api`.

endpointsOpenApiDocs

Tugas ini menghasilkan dokumen OpenAPI berdasarkan class layanan.

Anda dapat menggunakan properti berikut:

Properti	Deskripsi
serviceClasses	Daftar class layanan (class endpoint), ini dapat disimpulkan dari `web.xml`.
hostname	Untuk menetapkan URL root untuk dokumen OpenAPI yang dihasilkan. Misalnya, menggunakan `hostname = myapp.appspot.com` akan menghasilkan URL `host` dari `https://myapp.appspot.com` dan `basePath` sebagai `/_ah/api`.

Plugin sisi klien

Untuk menambahkan plugin Gradle Endpoints Framework sisi klien menggunakan kode berikut di build.gradle Anda:

apply plugin: 'com.google.cloud.tools.endpoints-framework-client'

Tetapkan konfigurasi sisi server di build.gradle Anda dengan penutupan endpointsClient:

endpointsClient {
  // client-side properties
}

Properti sisi klien

Plugin sisi klien tidak mengekspos tugas seperti plugin sisi server. Menerapkan plugin sisi klien akan menghasilkan sumber sesuai dengan properti konfigurasi berikut.

Properti	Deskripsi
discoveryDocs	Daftar dokumen penemuan yang akan digunakan saat membuat sumber.

Langkah selanjutnya

• Pelajari kode plugin dan laporkan masalah di GitHub.