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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

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

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

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

  1. פותחים את שרת ה-API של ה-API במסוף Apigee Edge, בתצוגה פיתוח.

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

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

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

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

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

  5. בחלונית השמאלית, בוחרים באפשרויות להגדרת המדיניות:
    שדה התיאור
    שם לתצוגה מזינים את השם המוצג של המדיניות.
    שם מזינים את השם שישמש למדיניות באופן פרוגרמטי. הערך הזה חייב להיות ייחודי בשרת ה-proxy.
    תוסף בוחרים את התוסף שבו רוצים להשתמש. זה התוסף שהגדרת קודם.
    פעולות בוחרים את הפעולה 'log' (יומן).
  6. לוחצים על הוספה.
  7. בתצוגת הזרימה, לוחצים על המדיניות כדי להציג את ה-XML של ההגדרה שלה.

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

  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