צירוף מדיניות ל-ProxyEndpoint או ל-TargetEndpoint Flow

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

כללי המדיניות לא מופעלים עד שמצרפים אותם ל-Flow. כדי ליצור קובץ מצורף של מדיניות, צריך לתת שם למדיניות בהגדרת שלב.

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

הפורמט של קובץ מדיניות מצורף הוא:

<Step>
    <Name>{policy_name}</Name>
</Step>

לדוגמה:

<Step>
    <Name>QuotaPolicy</Name>
</Step>

הערה: המשתנה {policy_name} צריך להיות זהה למאפיין name במדיניות (שמאוחסנת בתיקייה /policies) שרוצים לצרף. השמות חייבים להיות זהים, כי ההתאמה בין השמות היא תלוית-אותיות רישיות.

מדיניות מצורפת ל-Flow על ידי הוספת הגדרת השלב לבקשה המתאימה או לרכיב התגובה של Flow בהגדרת ProxyEndpoint או TargetEndpoint.

אפשר לצרף מדיניות לזרימת בקשה או תגובה. תהליכי הבקשה והתגובה מחולקים לתהליכי PreFlow ו-PostFlow.

בדוגמה הבאה מוצגת הגדרת ProxyEndpoint מינימלית, ללא קבצים מצורפים של מדיניות. הוא פשוט מגדיר את ה-HTTPProxyConnection (הנכנס) ואת ה-RouteRule.

<ProxyEndpoint name="default">
    <HTTPProxyConnection>
        <BasePath>/weather</BasePath>
        <VirtualHost>default</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="default">
        <TargetEndpoint>default</TargetEndpoint>
    </RouteRule>
</ProxyEndpoint>

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

כדי לאכוף את ההגדרה הזו, מצרפים שלב עיבוד ל-PreFlow של הבקשה באופן הבא:

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection> 
    <BasePath>/weather</BasePath> 
    <VirtualHost>default</VirtualHost> 
  </HTTPProxyConnection> 
  <RouteRule name="default"> 
    <TargetEndpoint>default</TargetEndpoint> 
  </RouteRule> 
</ProxyEndpoint>

לפעמים רוצים שמדיניות תופעל אחרי עיבוד ראשוני אחר ב-ProxyEndpoint. לדוגמה, אתם רוצים לבדוק את המכסה ב-PreFlow, ואז לבצע עוד סדרה של פעולות עיבוד אחרי בדיקת המכסה, כמו המרה של הבקשה מ-JSON ל-XML. כדי לעשות זאת, צריך לצרף מדיניות לנתיב הבקשה PostFlow. הדוגמה הבאה היא בקשה של קובץ מצורף מסוג PostFlow. המדיניות הזו תופעל בהודעת הבקשה אחרי שכל סוגי המדיניות ב-PreFlow (ובכל זרימה מותנית) יופעלו.

<PostFlow>
  <Request>
    <Step><Name>JSONtoXMLPolicy</Name></Step>
  </Request>
</PostFlow>

זוהי דוגמה לקובץ מצורף של PostFlow. המדיניות הזו תופעל על הודעת התגובה. (התגובה של ProxyEndpoint PostFlow היא שלב העיבוד הסופי לפני שהתגובה מוחזרת לאפליקציית הלקוח ששלחה את הבקשה).

<PostFlow>
  <Response>
    <Step><Name>XMLtoJSONPolicy</Name></Step>
  </Response>
</PostFlow>

טיפ: אפשר גם להגדיר רכיבי Flow מותנים שמופעלים בין השלבים PreFlow ו-PostFlow. הנושא הזה מוסבר בנושא הבא, משתני זרימה ותנאים.