פלאגין Gradle של Endpoints Framework

התוסף Endpoints Framework Gradle מספק משימות והגדרות לבנייה ולקישור של Endpoints Framework לפרויקטים של App Engine. הפלאגין הזה מספק תמיכה בצד השרת ובצד הלקוח. תוסף בצד השרת יוצר מסמכי גילוי ומפרטי OpenAPI מפרויקט Java של Endpoints Framework עם הערות וספריות לקוח. התוסף בצד הלקוח יוצר ספריות לקוח כשמסמך Discovery זמין.

תלות בפלאגין

מוסיפים את יחסי התלות של הפלאגין Endpoints Framework Gradle באמצעות קטע הקוד הבא בקובץ build.gradle. קטע הקוד הבא מאחזר את התלות מ-Maven Central:

classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2'

פלאגין בצד השרת

מוסיפים את הפלאגין Endpoints Framework Gradle בצד השרת באמצעות קטע הקוד הבא בקובץ build.gradle:

apply plugin: 'com.google.cloud.tools.endpoints-framework-server'

מגדירים את התצורה בצד השרת ב-build.gradle באמצעות endpointsServer:

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

משימות ומאפיינים בצד השרת

המשימות הבאות חשופות רק בצד השרת.

endpointsClientLibs

המשימה הזו יוצרת ספריות לקוח של נקודות קצה על סמך מחלקות שירות.

אפשר להשתמש במאפיינים הבאים:

מאפיין (property)	תיאור
serviceClasses	רשימה של מחלקות שירות (מחלקות של נקודות קצה), שאפשר להסיק מתוך הקובץ `web.xml`.
clientLibDir	ספריית הפלט של ספריות הלקוח שנוצרו.
hostname	כדי להגדיר את כתובת ה-URL הבסיסית לספריות הלקוח שנוצרו. לדוגמה, שימוש ב-`hostname = myapp.appspot.com` יגרום לכתובת URL של שורש ברירת המחדל להיות `https://myapp.appspot.com/_ah/api`.

endpointsDiscoveryDocs

המשימה הזו יוצרת מסמכי גילוי על סמך מחלקות שירות.

אפשר להשתמש במאפיינים הבאים:

מאפיין (property)	תיאור
serviceClasses	רשימה של מחלקות שירות (מחלקות של נקודות קצה), שאפשר להסיק מתוך הקובץ `web.xml`.
hostname	כדי להגדיר את כתובת ה-URL הבסיסית למסמך ה-Discovery שנוצר. לדוגמה: השימוש ב-`hostname = myapp.appspot.com` יגרום לכתובת URL של שורש ברירת המחדל של `https://myapp.appspot.com/_ah/api`.

endpointsOpenApiDocs

במשימה הזו נוצרים מסמכי OpenAPI על סמך מחלקות שירות.

אפשר להשתמש במאפיינים הבאים:

מאפיין (property)	תיאור
serviceClasses	רשימה של מחלקות שירות (מחלקות של נקודות קצה), שאפשר להסיק מתוך הקובץ `web.xml`.
hostname	כדי להגדיר את כתובת ה-URL הבסיסית למסמך OpenAPI שנוצר. לדוגמה: השימוש ב-`hostname = myapp.appspot.com` יגרום לכך שכתובת ה-URL של `host` תהיה `https://myapp.appspot.com` ו-`basePath` יהיה `/_ah/api`.

פלאגין בצד הלקוח

כדי להוסיף את התוסף Endpoints Framework Gradle בצד הלקוח, משתמשים בפקודה הבאה בקובץ build.gradle:

apply plugin: 'com.google.cloud.tools.endpoints-framework-client'

מגדירים את התצורה בצד השרת ב-build.gradle באמצעות endpointsClient:

endpointsClient {
  // client-side properties
}

מאפיינים בצד הלקוח

התוסף בצד הלקוח לא חושף משימות כמו התוסף בצד השרת. הפעלת הפלאגין בצד הלקוח תיצור מקורות בהתאם למאפייני ההגדרה הבאים.

מאפיין (property)	תיאור
discoveryDocs	רשימה של מסמכי גילוי לשימוש ביצירת מקורות.

המאמרים הבאים

• אפשר לעיין בקוד של הפלאגין ולדווח על בעיות ב-GitHub.