כלי שורת הפקודה של Cloud Endpoints Frameworks for App Engine

בדף הזה מוסבר איך ליצור ספריית לקוח מ-API של שרת בק-אנד באמצעות כלי שורת הפקודה של Endpoints Frameworks. כל אפליקציית Java או Android יכולה להשתמש בספרייה הזו כדי לקרוא ל-API.

אתם יכולים ליצור חבילות של ספריות לקוח שמאפשרות לאפליקציות לגשת ל-API שלכם באמצעות כלי שורת הפקודה של Endpoints Frameworks. כשיוצרים ספריית לקוח, כלי שורת הפקודה של Endpoints Frameworks יוצר באופן אוטומטי מסמך Discovery שמתאר את הממשק של ה-API.

כדי להוריד את כלי שורת הפקודה של Endpoints Frameworks, מורידים את endpoints-framework-tools מ-Maven Central Repository. אחרי שחילוץ התוכן מקובץ ה-ZIP מסתיים, הכלי נמצא בספרייה endpoints-framework-tools-2.2.1/bin/.

יצירת חבילה של ספריית לקוח מ-API

אתם יכולים להשתמש בכלי שורת הפקודה של Endpoints Frameworks כדי ליצור את סוגי חבילות הלקוח הבאים:

  • ‫Maven: החבילה הזו כוללת קובץ pom.xml עם התלויות של Endpoints Frameworks ושל ספריית הלקוח של Google API. קובץ readme.html מספק מידע מפורט על מה שצריך להוסיף לקובץ pom.xml עבור סוגים שונים של אפליקציות לקוח, ועל האופן שבו אפשר ליצור ספריית לקוח עבור ה-API באמצעות Maven.

  • ‫Gradle: החבילה הזו כוללת קובץ build.gradle עם התלויות ב-Endpoints Frameworks וב-Google API Client Library. קובץ readme.html מספק מידע מפורט על מה שצריך להוסיף לקובץ build.gradle עבור סוגים שונים של אפליקציות לקוח, ועל אופן יצירת ספריית לקוח עבור ה-API באמצעות Gradle.

  • חבילת לקוח ברירת מחדל: החבילה הזו מכילה את כל ספריות התלות ואת קובץ source.jar שנוצר, שהוא ספריית Java שבה אתם משתמשים בלקוח כדי לקרוא ל-API. החבילה הזו מספקת ללקוח את כל היכולות של ספריית הלקוח של Google API, כולל OAuth. בקובץ readme.html מפורטים הקבצים שנדרשים לסוגים שונים של אפליקציות לקוח ופרטים נוספים לשימוש בספריית הלקוח..jar

אם אתם משתמשים בספריית הלקוח עם אפליקציית Android, מומלץ להשתמש בחבילת לקוח של Gradle.

תחביר של שורת פקודה

לפני שמשתמשים בכלי שורת הפקודה של Endpoints Frameworks, צריך לבנות את פרויקט הקצה העורפי כי הכלי הזה דורש קבצים בינאריים שעברו קומפילציה. אפשר גם לספק את האפשרות --war= שמצביעה על ספריית הפלט של יעד ה-build שמכילה את הספרייה WEB-INF ואת מחלקות ה-Java שעברו קומפילציה, אם לא רוצים להשתמש בברירת המחדל (--war="./war").

התחביר הבסיסי הוא כזה:

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

where:

  • ‫OPTIONS, אם מצוין, הוא אחד או יותר מהפריטים שמוצגים בטבלת האפשרויות.
  • ‫CLASS_NAME הוא שם המחלקה המלא של ה-API.

לדוגמה:

/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

‫target/echo-1.0-SNAPSHOT הוא הנתיב היחסי או המוחלט לספריית היעד של ה-build שמכילה את WEB-INF ואת המחלקות של ה-backend שעברו קומפילציה.

אפשרויות

אפשר להשתמש באפשרויות הבאות:

שם האפשרות תיאור דוגמה
build-system מאפשר לציין איזה סוג של חבילת לקוח צריך ליצור. מציינים gradle לחבילת לקוח של Gradle ל-Android,‏ maven לחבילת לקוח של Maven או default (או פשוט משמיטים את האפשרות הזו) לחבילה שמכילה רק את ספריות התלות ואת קובץ ה-JAR של המקור. --build-system=gradle
-bs gradle
war מגדיר את הנתיב לספריית יעד הבנייה WEB-INF שמכילה את appengine-web.xml ומטא-נתונים אחרים.
ברירת מחדל: ./war.		 --war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output הגדרת הספרייה שבה ייכתב הפלט.
ברירת מחדל: הספרייה שממנה מופעל הכלי.		 --output=/mydir
-o /mydir

פלטפורמות לקוחות נתמכות

הפלטפורמות הבאות נתמכות בחבילת הלקוח שנוצרת על ידי כלי שורת הפקודה של Endpoints Frameworks: