שלב 3: שימוש במדיניות ExtensionCallout (יתרונות מרכזיים)

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

כשמפתחים proxy ל-API, אפשר להוסיף תמיכה בתוסף על ידי הוספת מדיניות ExtensionCallout ל-proxy. (אם אתם רוצים עזרה ביצירת שרת proxy פשוט, תוכלו לעיין במאמר יצירת שרת proxy ראשון).

כשמוסיפים תמיכה בתוסף, מקשרים את המדיניות ExtensionCallout לתוסף מוגדר. ההגדרות של התוסף קובעות איך התוסף מתקשר עם משאב הקצה העורפי שאליו הוא מתחבר. התוסף הזה, שהוגדר באופן ספציפי, הוא זה שמדיניות ExtensionCallout משלבת ב-proxy ל-API.

כדי להוסיף תוסף ל-proxy ל-API:

1. פותחים את ה-proxy ל-API במסוף Apigee Edge בתצוגה Develop (פיתוח).

   כדי ליצור תוסף, צריך להיות אדמין בארגון, אבל כל תפקיד משתמש יכול להוסיף את התוסף ל-proxy ל-API.

2. בחלונית Navigator, בוחרים באפשרות PreFlow.

   

3. בפינה השמאלית העליונה, לוחצים על הלחצן + שלב כדי להוסיף מדיניות.

   

4. בתיבת הדו-שיח הוספת שלב, ברשימת כללי המדיניות בצד ימין, לוחצים על תוסף יתרונות מרכזיים.

   

   אם המדיניות ExtensionCallout לא מופיעה ברשימה, צריך לוודא שאתם משתמשים בממשק המשתמש החדש של Edge. בנוסף, Apigee Extensions זמין כרגע רק ללקוחות Apigee Edge Cloud Enterprise.

5. בחלונית השמאלית, בוחרים אפשרויות להגדרת המדיניות:

   שדה	תיאור
   שם לתצוגה	מזינים את השם המוצג של המדיניות.
   שם	מזינים את השם שבו רוצים להשתמש במדיניות באופן פרוגרמטי. הערך הזה חייב להיות ייחודי בשרת ה-proxy.
   תוסף	בוחרים את התוסף שבו רוצים להשתמש. זהו התוסף שהגדרתם קודם.
   פעולות	בוחרים בפעולה 'רישום ביומן'.

6. לוחצים על הוספה.
7. בתצוגת התהליך, לוחצים על המדיניות כדי לראות את קובץ ה-XML של ההגדרה שלה.

   

   כשמוסיפים את התוסף, מקבלים דוגמה ל-XML של מדיניות. שימו לב שהוא כולל סכימה שמתארת איך לבנות את ההגדרה של רכיב <Input>. (אפשר להתעלם מסכימת הרכיב <Output> – לא מוחזר גוף תגובה על ידי פעולת ה'יומן' של התוסף).

8. עורכים את קובץ ה-XML של המדיניות כך שייראה כמו הדוגמה הבאה:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Extension-Callout-Beta-1">
     <DisplayName>Logging Extension</DisplayName>
     <Connector>my-logging-extension</Connector>
     <Action>log</Action>
     <Input>{
       "logName": "example-log",
       "metadata": {
         "resource": {
           "type": "global",
           "labels": {
             "project_id": "my-gcp-project"
           }
         }
       },
       "message": "This is a test"
     }</Input>
   </ConnectorCallout><!--
   Input JSON Schema for package=gcp-stackdriver-logging version=0.0.4
   {"type":"object","properties":{"logName":{"type":"string"},"metadata":{"type":"string"},"message":{"type":"string"}},"required":["logName","message"]}
   -->
   <!--
   Output JSON Schema for package=gcp-stackdriver-logging version=0.0.4
   {"type":"object","properties":{"content":{"type":"string"}},"required":[]}
   -->

   במקרה הזה, התג <Input> מגדיר את הפרטים הבאים:

   • ‫logName הוא שם היומן שרוצים לכתוב אליו. אם הוא לא קיים, התוסף ייצור אותו.
   • ‫metadata מציין מידע שאפשר להשתמש בו כדי לעיין ביומן במסוף Stackdriver.
   • ‫message הוא פשוט הודעת היומן שרוצים לכתוב.
9. לוחצים על הלחצן שמירה.

השלב הבא

שלב 1 שלב 2 שלב 3 שלב 4: פריסת ה-proxy שלב 5