Plugin Gradle Framework Endpoints

Plugin Gradle Endpoints Framework memberikan tugas dan konfigurasi untuk membuat dan menghubungkan Framework Endpoint untuk project App Engine. Plugin ini memberikan dukungan sisi server dan sisi klien. Plugin sisi server menghasilkan dokumen Discovery dan spesifikasi OpenAPI dari library klien dan project Java Endpoints Framework yang telah dianotasi. Plugin sisi klien membuat library klien saat dokumen discovery tersedia.

Dependensi plugin

Tambahkan dependensi plugin Gradle Endpoints Framework 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 Anda:

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

Tetapkan konfigurasi sisi server di build.gradle 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 membuat library klien endpoint berdasarkan class layanan.

Anda dapat menggunakan properti berikut:

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

`endpointsDiscoveryDocs`

Tugas ini membuat dokumen discovery berdasarkan class layanan.

Anda dapat menggunakan properti berikut:

Properti	Deskripsi
`serviceClasses`	Daftar class layanan (class endpoint), hal ini dapat disimpulkan dari `web.xml`.
`hostname`	Untuk menetapkan URL root bagi dokumen discovery yang dibuat. Misalnya, penggunaan `nama host = 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), hal ini dapat disimpulkan dari `web.xml`.
`hostname`	Untuk menetapkan URL root bagi dokumen OpenAPI yang dihasilkan. Misalnya, penggunaan `nama host = myapp.appspot.com` akan menghasilkan URL `host` untuk `https://myapp.appspot.com` dan `basePath` sebagai `/_ah/api`.

Plugin sisi klien

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

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

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

endpointsClient {
  // client-side properties
}

Properti sisi klien

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

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

Langkah selanjutnya

Pelajari kode plugin dan laporkan masalah di GitHub.