‫Endpoints Framework Maven plugin

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

הוספה של התוסף Endpoints Framework Maven

מוסיפים את הפלאגין Endpoints Framework Maven באמצעות קטע הפלאגין הבא לקובץ pom.xml:

<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>

יעדים של תוספים

אחרי שמוסיפים את הפלאגין Endpoints Framework Maven, מופיעים יעדי Maven ספציפיים ל-Endpoints Framework:

צד השרת

מטרה תיאור
endpoints-framework:clientLibs יצירה של ספריות לקוח
endpoints-framework:discoveryDocs יוצר מסמכי Discovery
endpoints-framework:openApiDocs יצירת מסמכי OpenAPI

בצד הלקוח

מטרה תיאור
endpoints-framework:generateSrc יוצר ספריות לקוח ממסמכי גילוי.

פרמטרים של יעדים

לכל יעד יש פרמטרים משויכים שאפשר להשתמש בהם. אפשר לציין את ההגדרות האלה ב-pom.xml או בשורת הפקודה.

כדי להגדיר את ההגדרות האלה ב-pom.xml, מוסיפים את שם הפרמטר לקטע <configuration>.

אפשרות אחרת היא להגדיר את ההגדרות האלה בשורת הפקודה לפי התבנית -D[USER_PROPERTY]=[PARAMETER_VALUE].

בקטעים הבאים מפורטת רשימה של הפרמטרים שזמינים לכל יעד.

endpoints-framework:clientLibs

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

פרמטר תיאור מאפיין משתמש
clientLibDir הגדרה של המיקום של ספריות הלקוח שנוצרו. מיקום ברירת המחדל מוגדר כ-`target/client-libs`. endpoints.clientLibDir
serviceClasses פרמטר אופציונלי שמשמש לציון רשימה של שמות של מחלקות שירות (מחלקות של נקודות קצה). אפשר להסיק את זה מהקובץ `web.xml`. endpoints.serviceClasses
webappDir מציינים את המיקום של ספריית webapp. מיקום ברירת המחדל מוגדר כ-`src/main/webapp`. endpoints.webappDir
hostname כדי להגדיר את כתובת ה-URL הבסיסית לספריות לקוח. לדוגמה: השימוש ב-`hostname = myapp.appspot.com` יוביל לכתובת URL בסיסית שמוגדרת כברירת מחדל של`https://myapp.appspot.com/_ah/api` endpoints.hostname

endpoints-framework:discoveryDocs

המטרה הזו היא ליצור מסמכי גילוי.

פרמטר תיאור מאפיין משתמש
discoveryDocDir הגדרת מיקום למסמכי Discovery שנוצרו. מיקום ברירת המחדל מוגדר כ-`target/discovery-docs`. endpoints.discoveryDocDir
serviceClasses פרמטר אופציונלי שמשמש לציון רשימה של שמות של מחלקות שירות (מחלקות של נקודות קצה). אפשר להסיק את זה מהקובץ `web.xml`. endpoints.serviceClasses
webappDir מציינים את המיקום של ספריית webapp. מיקום ברירת המחדל מוגדר כ-`src/main/webapp`. endpoints.webappDir
hostname כדי להגדיר את כתובת ה-URL הבסיסית למסמכי Discovery. לדוגמה: השימוש ב-`hostname = myapp.appspot.com` יוביל לכתובת URL בסיסית שמוגדרת כברירת מחדל של`https://myapp.appspot.com/_ah/api` endpoints.hostname

endpoints-framework:openApiDocs

המטרה הזו יוצרת מסמכי OpenAPI.

פרמטר תיאור מאפיין משתמש
openApiDocDir הגדרת מיקום למסמכי OpenAPI שנוצרו. מיקום ברירת המחדל מוגדר כ-`target/openapi-docs`. endpoints.openApiDocDir
serviceClasses פרמטר אופציונלי שמשמש לציון רשימה של שמות של מחלקות שירות (מחלקות של נקודות קצה). אפשר להסיק את זה מהקובץ `web.xml`. endpoints.serviceClasses
webappDir מציינים את המיקום של ספריית webapp. מיקום ברירת המחדל מוגדר כ-`src/main/webapp`. endpoints.webappDir
hostname כדי להגדיר את כתובת ה-URL הבסיסית למסמכי OpenAPI. לדוגמה: השימוש ב-`hostname = myapp.appspot.com` יוביל לכתובת URL בסיסית שמוגדרת כברירת מחדל של`https://myapp.appspot.com/_ah/api` endpoints.hostname

endpoints-framework:generateSrc

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

פרמטר תיאור מאפיין משתמש
discoveryDocs מגדירים רשימה של מסמכי גילוי. endpoints.discoveryDocs
generatedSrcDir ספריית הפלט של המקורות של ספריית הלקוח שנוצרה. מיקום ברירת המחדל הוא `target/generated-sources/`. endpoints.generatedSrcDir

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

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