צירוף והגדרה של כללי מדיניות בממשק המשתמש

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

הוספת יכולות מבוססות-מדיניות ל-proxy ל-API היא תהליך שכולל שני שלבים:

1. הגדרת מופע של סוג מדיניות.
2. מצרפים את מופע המדיניות ל-Flow.

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

סוג אחד של מדיניות שנמצא בשימוש נפוץ הוא SpikeArrest. ‫SpikeArrest מונע עליות פתאומיות בתנועת ההודעות, שעלולות להציף את שירותי ה-Backend.

צירוף מדיניות לתהליך

כדי לצרף מדיניות ל-Flow:

1. בוחרים ב-proxy ל-API ועוברים לתצוגה Develop (פיתוח).
2. בחלונית הניווט של הכלי לעריכת שרתי proxy של API, בוחרים את ה-Flow שאליו רוצים לצרף מדיניות.
   לדוגמה, בתרשים הבא נבחר התהליך PreFlow לנקודת הקצה של proxy ל-API שמוגדר כברירת מחדל:
   
3. בתצוגת העיצוב, לוחצים על +שלב שמשויך לזרימת הבקשה או התגובה כדי לצרף מדיניות. לדוגמה:
   
   תיבת הדו-שיח 'הוספת שלב' נפתחת ומוצגת בה רשימה של מדיניות לפי קטגוריות.
   
4. גוללים ובוחרים את סוג המדיניות שרוצים לצרף לזרימה שנבחרה.
5. משנים את השדות הבאים.

   • השם המוצג: שם מוצג ייחודי למדיניות. ממשק המשתמש ייצור שם ברירת מחדל, אבל מומלץ ליצור שם תיאורי למדיניות. כך מפתחים אחרים בארגון יוכלו להבין בקלות את מטרת המדיניות.

   • שם: שם ייחודי למדיניות. שם המדיניות זהה לשם המוצג, למעט במקרים הבאים:

     • רווחים מוחלפים במקפים.

     • רצף של מקפים מוחלף במקף יחיד.

     • חוץ ממקפים, קווים תחתונים ורווחים (שמוחלפים, כמו שצוין למעלה), תווים שהם לא אלפאנומריים, כמו סימני פאונד, סימני אחוז, אמפרסנד וכו', מוסרים.

6. לוחצים על Add (הוספה).

   המדיניות מצורפת לתהליך שנבחר.

אחרי שמצרפים את המדיניות, היא מוצגת בתצוגה Designer של התהליך. בדוגמה הזו, PreFlow של נקודת הקצה של ה-proxy שמוגדר כברירת מחדל, וברשימה Policies בחלונית הניווט. התצוגה קוד, שבה מוצג קוד ה-XML של המדיניות שצורפה, מוצגת מתחת לתצוגה מעצב. ‫Edge יוצר מופע של המדיניות שמכיל קבוצה של ערכי ברירת מחדל סבירים.

הוספת מדיניות בלי לצרף אותה לזרימת נתונים

כדי להוסיף מדיניות בלי לצרף אותה לזרימת נתונים (שימושי לטיפול בשגיאות), לוחצים על + בסרגל Policies בתצוגה Navigator כדי לפתוח את תיבת הדו-שיח Add Policy ולהוסיף את המדיניות (כמו שמתואר בשלבים 4 עד 6 בקטע הקודם).

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

אחרי שיוצרים את המדיניות, אפשר לצרף אותה לזרימה על ידי גרירה ושחרור שלה מרשימת Policies לזרימה הרצויה בתצוגה Designer.

ביטול ההצמדה של כללי מדיניות לזרימה

כדי לנתק מדיניות מ-Flow, בוחרים את ה-Flow. מעבירים את העכבר מעל סמל המדיניות בתצוגה Designer של הזרימה. לוחצים על X בעיגול שמופיע בסמל.

מחיקה של מופע מדיניות

כדי למחוק מופע של מדיניות, מעבירים את העכבר מעל הרשומה של המדיניות בתצוגה Navigator. לוחצים על X בעיגול שמופיע משמאל לרשומה.

הגדרת כללי מדיניות בממשק המשתמש

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

אפשר להגדיר מדיניות על ידי עריכה ישירה של הגדרות ה-XML שלה בתצוגה Code. לדוגמה, קצב ההודעות המקסימלי שמוגדר במדיניות Spike Arrest הוא 30 הודעות לשנייה. כדי לשנות את התעריף בשעות השיא, צריך לשנות את הערך של רכיב <Rate> ב-XML של המדיניות. פרטים נוספים על הגדרת מדיניות זמינים בדף העזר בנושא מדיניות.

אפשר גם לגזור ולהדביק מדיניות בתצוגה Code (קוד). כך תוכלו לעשות שימוש חוזר במדיניות מתוך הדוגמאות שזמינות ב-GitHub.

כשמבצעים שינויים בהגדרת מדיניות בתצוגה Code, השינויים משתקפים בProperty Inspector. ולהיפך – אם מבצעים שינויים בProperty Inspector, הם מופיעים ב-XML בתצוגת Code.

לעיון בתיעוד ספציפי למדיניות המכסות שבה נעשה שימוש בנושא הזה, אפשר לעבור אל מדיניות מכסות.