Framework Cloud Endpoints untuk alat command line App Engine

Halaman ini menjelaskan cara membuat library klien dari API server backend Anda menggunakan alat command line Endpoints Frameworks. Aplikasi Java atau Android apa pun dapat menggunakan library ini untuk memanggil API.

Anda dapat membuat paket library klien yang memungkinkan aplikasi mengakses API Anda menggunakan alat command line Endpoints Frameworks. Saat Anda membuat library klien, alat command line Endpoints Frameworks akan otomatis membuat Dokumen penemuan yang menjelaskan permukaan API Anda.

Untuk mendapatkan alat command line Endpoints Frameworks, download endpoints-framework-tools dari Maven Central Repository. Setelah Anda mengekstrak konten file zip, alat ini akan berada di direktori endpoints-framework-tools-2.2.1/bin/.

Membuat paket library klien dari API

Anda dapat menggunakan alat command line Endpoints Frameworks untuk membuat jenis paket klien berikut:

  • Maven: Paket ini mencakup file pom.xml dengan dependensi Endpoints Frameworks dan Library Klien Google API. File readme.html memberikan informasi mendetail tentang apa yang perlu Anda tambahkan ke file pom.xml untuk berbagai jenis aplikasi klien dan cara membuat library klien untuk API Anda menggunakan Maven.

  • Gradle: Paket ini mencakup file build.gradle dengan dependensi Endpoints Frameworks dan Google API Client Library. File readme.html memberikan informasi mendetail tentang apa yang perlu Anda tambahkan ke file build.gradle untuk berbagai jenis aplikasi klien dan cara membuat library klien untuk API Anda menggunakan Gradle.

  • Paket klien default: Paket ini berisi semua library dependensi dan file source.jar yang dihasilkan, yaitu library Java yang Anda gunakan di klien untuk memanggil API. Paket ini menyediakan semua kemampuan Library Klien Google API, termasuk OAuth, untuk klien Anda. File readme.html mencantumkan file .jar yang diperlukan untuk berbagai jenis aplikasi klien dan detail lainnya untuk menggunakan library klien.

Jika Anda menggunakan library klien dengan aplikasi Android, sebaiknya gunakan paket klien Gradle.

Sintaksis command line

Sebelum menggunakan alat command line Endpoints Frameworks, Anda harus membangun project backend karena alat ini memerlukan biner yang dikompilasi. Anda dapat secara opsional memberikan opsi --war= yang mengarah ke direktori output target build yang berisi direktori WEB-INF dan class java yang dikompilasi jika Anda tidak ingin menggunakan default (--war="./war").

Sintaksis dasarnya adalah sebagai berikut:

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib OPTIONS CLASS_NAME

dengan:

  • OPTIONS, jika diberikan, adalah satu atau beberapa item yang ditampilkan dalam tabel Opsi.
  • CLASS_NAME adalah nama class API Anda yang sepenuhnya memenuhi syarat.

Contoh:

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib --war=target/echo-1.0-SNAPSHOT -bs gradle com.example.echo.Echo

dengan target/echo-1.0-SNAPSHOT adalah jalur relatif atau absolut ke target build yang berisi WEB-INF dan class backend yang dikompilasi.

Opsi

Anda dapat menggunakan opsi berikut:

Nama opsi Deskripsi Contoh
build-system Memungkinkan Anda menentukan jenis paket klien yang harus dibuat. Tentukan gradle untuk paket klien Gradle untuk Android, maven untuk paket klien Maven, atau default (atau cukup hapus opsi ini) untuk paket yang hanya berisi library dependensi dan jar sumber. --build-system=gradle
-bs gradle
war Menetapkan jalur ke direktori target build WEB-INF yang berisi appengine-web.xml dan metadata lainnya.
Default: ./war.		 --war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output Menetapkan direktori tempat output ditulis.
Default: direktori tempat alat dipanggil.		 --output=/mydir
-o /mydir

Platform klien yang didukung

Platform berikut didukung dalam paket klien yang dihasilkan oleh alat command line Endpoints Frameworks: