Halaman ini diterjemahkan oleh Cloud Translation API.

Plugin Maven Framework Endpoints

Plugin Maven Framework Endpoints menyediakan tugas dan konfigurasi untuk mem-build project Framework Endpoints. Plugin ini menyediakan dukungan sisi server dan sisi klien. Sasaran sisi server menghasilkan dokumen Discovery dan spesifikasi OpenAPI dari project Java Framework Endpoints yang dianotasi dan library klien. Sasaran sisi klien menghasilkan library klien saat dokumen penemuan tersedia.

Menambahkan plugin Maven Framework Endpoints

Tambahkan plugin Maven Framework Endpoints menggunakan cuplikan plugin berikut ke pom.xml:

<plugin>
  <groupId>com.google.cloud.tools</groupId>
  <artifactId>endpoints-framework-maven-plugin</artifactId>
  <version>1.0.2</version>
  <configuration>
    <!-- plugin configuration -->
    <hostname>${endpoints.project.id}.appspot.com</hostname>
  </configuration>
</plugin>

Sasaran plugin

Setelah Anda menambahkan plugin Maven Framework Endpoints, sasaran Maven khusus Framework Endpoints berikut akan tersedia:

Sisi server

Sasaran	Deskripsi
`endpoints-framework:clientLibs`	Menghasilkan library klien
`endpoints-framework:discoveryDocs`	Membuat dokumen penemuan
`endpoints-framework:openApiDocs`	Membuat dokumen OpenAPI

Sisi klien

Sasaran	Deskripsi
`endpoints-framework:generateSrc`	Membuat library klien dari dokumen penemuan.

Parameter sasaran

Setiap sasaran memiliki parameter terkait yang dapat Anda gunakan. Anda dapat menentukan setelan ini di pom.xml atau di command line.

Untuk mengonfigurasi setelan ini di pom.xml, tambahkan nama parameter di bagian <configuration>.

Atau, untuk mengonfigurasi setelan ini di command line, ikuti pola -D[USER_PROPERTY]=[PARAMETER_VALUE].

Lihat bagian berikut untuk mengetahui daftar parameter yang tersedia untuk setiap sasaran.

`endpoints-framework:clientLibs`

Sasaran ini menghasilkan library klien dari sisi server.

Parameter	Deskripsi	Properti Pengguna
`clientLibDir`	Tentukan lokasi library klien yang dihasilkan. Lokasi default ditentukan sebagai `target/client-libs`.	`endpoints.clientLibDir`
`serviceClasses`	Parameter opsional untuk memberikan Daftar nama class layanan (class endpoint). Hal ini dapat disimpulkan dari `web.xml`.	`endpoints.serviceClasses`
`webappDir`	Berikan lokasi direktori `webapp`. Lokasi default ditentukan sebagai `src/main/webapp`.	`endpoints.webappDir`
`hostname`	Untuk menetapkan URL root untuk library klien. Misalnya, menggunakan `hostname = myapp.appspot.com` akan menghasilkan URL root default`https://myapp.appspot.com/_ah/api`	`endpoints.hostname`

`endpoints-framework:discoveryDocs`

Sasaran ini menghasilkan dokumen penemuan.

Parameter	Deskripsi	Properti Pengguna
`discoveryDocDir`	Tentukan lokasi untuk dokumen penemuan yang dihasilkan. Lokasi default ditentukan sebagai `target/discovery-docs`.	`endpoints.discoveryDocDir`
`serviceClasses`	Parameter opsional untuk memberikan Daftar nama class layanan (class endpoint). Hal ini dapat disimpulkan dari `web.xml`.	`endpoints.serviceClasses`
`webappDir`	Berikan lokasi direktori `webapp`. Lokasi default ditentukan sebagai `src/main/webapp`.	`endpoints.webappDir`
`hostname`	Untuk menetapkan URL root untuk dokumen penemuan. Misalnya, menggunakan `hostname = myapp.appspot.com` akan menghasilkan URL root default`https://myapp.appspot.com/_ah/api`	`endpoints.hostname`

`endpoints-framework:openApiDocs`

Sasaran ini menghasilkan dokumen OpenAPI.

Parameter	Deskripsi	Properti Pengguna
`openApiDocDir`	Menentukan lokasi untuk dokumen OpenAPI yang dihasilkan. Lokasi defaultnya ditentukan sebagai `target/openapi-docs`.	`endpoints.openApiDocDir`
`serviceClasses`	Parameter opsional untuk memberikan Daftar nama class layanan (class endpoint). Hal ini dapat disimpulkan dari `web.xml`.	`endpoints.serviceClasses`
`webappDir`	Berikan lokasi direktori `webapp`. Lokasi default ditentukan sebagai `src/main/webapp`.	`endpoints.webappDir`
`hostname`	Untuk menetapkan URL root untuk dokumen OpenAPI. Misalnya, menggunakan `hostname = myapp.appspot.com` akan menghasilkan URL root default`https://myapp.appspot.com/_ah/api`	`endpoints.hostname`

`endpoints-framework:generateSrc`

Sasaran ini menghasilkan sumber klien dari dokumen penemuan.

Parameter	Deskripsi	Properti Pengguna
`discoveryDocs`	Menentukan daftar dokumen penemuan.	`endpoints.discoveryDocs`
`generatedSrcDir`	Direktori output untuk sumber library klien yang dihasilkan. Lokasi default-nya adalah di `target/generated-sources/`.	`endpoints.generatedSrcDir`

Langkah selanjutnya

Pelajari kode plugin dan laporkan masalah di GitHub.