Plugin Maven Framework Endpoints

Plugin Maven Framework Endpoints menyediakan tugas dan konfigurasi untuk mem-build project Framework Endpoint. Plugin ini memberikan dukungan sisi server dan sisi klien. Sasaran sisi server menghasilkan dokumen Discovery dan spesifikasi OpenAPI dari project Java Endpoints Framework 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 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 Framework Endpoint, sasaran Maven khusus Endpoints Framework berikut akan tersedia:

Sisi server

Tujuan Deskripsi
endpoints-framework:clientLibs Membuat library klien
endpoints-framework:discoveryDocs Menghasilkan dokumen discovery
endpoints-framework:openApiDocs Menghasilkan dokumen OpenAPI

Sisi klien

Tujuan Deskripsi
endpoints-framework:generateSrc Membuat library klien dari dokumen discovery.

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 pada 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 dibuat. Lokasi default ditentukan sebagai `target/client-libs`. endpoints.clientLibDir
serviceClasses Parameter opsional untuk memberikan Daftar nama class layanan (class endpoint). 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 bagi library klien. Misalnya, penggunaan `nama host = 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 Menentukan lokasi untuk dokumen discovery yang dibuat. Lokasi default ditentukan sebagai `target/discovery-docs`. endpoints.discoveryDocDir
serviceClasses Parameter opsional untuk memberikan Daftar nama class layanan (class endpoint). 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 bagi dokumen discovery. Misalnya, penggunaan `nama host = 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 Menentukan lokasi untuk dokumen OpenAPI yang dihasilkan. Lokasi default ditentukan sebagai `target/openapi-docs`. endpoints.openApiDocDir
serviceClasses Parameter opsional untuk memberikan Daftar nama class layanan (class endpoint). 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 bagi dokumen OpenAPI. Misalnya, penggunaan `nama host = 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 discovery.

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

Langkah selanjutnya

  • Pelajari kode plugin dan laporkan masalah di GitHub.