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

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

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

  1. הגדרת מופע של סוג מדיניות.
  2. צירוף של מופע המדיניות ל-flow.

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

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

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

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

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

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

    • שם: השם הייחודי של המדיניות. שם המדיניות תואם לשם המוצג, למעט כמה יוצאים מן הכלל:

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

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

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

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

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

לאחר צירוף המדיניות, המדיניות תוצג בתצוגה המעצב של התהליך, בדוגמה הזו – PreFlow של נקודת הקצה של שרת ה-Proxy המוגדרת כברירת מחדל, וברשימה Policy (מדיניות) בחלונית הניווט. התצוגה Code (קוד) שבה מוצג ה-XML של המדיניות שצורפה לאחרונה, מופיעה מתחת לתצוגת המעצב. Edge יוצרת מופע של המדיניות שמכיל קבוצה של ערכי ברירת מחדל סבירים.

כללי המדיניות ב-PreFlow בתצוגת המעצב ותצוגת הקוד

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

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

יש ללחוץ על + כדי להוסיף מדיניות

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

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

ניתוק מדיניות מרצף

כדי לנתק מדיניות מזרימה, בוחרים את הזרימה. מעבירים את העכבר מעל סמל המדיניות בתצוגת המעצב של הזרימה. יש ללחוץ על ה-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 עבור המדיניות. לפרטים נוספים על הגדרת מדיניות, אפשר לעיין בחומר העזר בנושא מדיניות.

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

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

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