Plugin Maven Framework Endpoints

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

Tambahkan plugin Maven Framework Endpoints

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

<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 Endpoints Framework, sasaran Maven khusus Endpoints Framework berikut akan tersedia:

Sisi server

Sasaran	Deskripsi
endpoints-framework:clientLibs	Membuat 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

Tujuan ini menghasilkan library klien dari sisi server.

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

endpoints-framework:discoveryDocs

Tujuan 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 kelas layanan (kelas endpoint). Hal ini dapat disimpulkan dari `web.xml`.	endpoints.serviceClasses
webappDir	Berikan lokasi direktori `webapp`. Lokasi default ditetapkan 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

Tujuan ini menghasilkan dokumen OpenAPI.

Parameter	Deskripsi	Properti Pengguna
openApiDocDir	Tentukan lokasi untuk dokumen OpenAPI yang dihasilkan. Lokasi default ditentukan sebagai `target/openapi-docs`.	endpoints.openApiDocDir
serviceClasses	Parameter opsional untuk memberikan Daftar nama kelas layanan (kelas endpoint). Hal ini dapat disimpulkan dari `web.xml`.	endpoints.serviceClasses
webappDir	Berikan lokasi direktori `webapp`. Lokasi default ditetapkan 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

Tujuan ini menghasilkan sumber klien dari dokumen penemuan.

Parameter	Deskripsi	Properti Pengguna
discoveryDocs	Tentukan daftar dokumen penemuan.	endpoints.discoveryDocs
generatedSrcDir	Direktori output untuk sumber library klien yang dibuat. Lokasi defaultnya ada di `target/generated-sources/`.	endpoints.generatedSrcDir

Langkah berikutnya

• Pelajari kode plugin dan laporkan masalah di GitHub.