מדיניות FlowCallout

אימות מפתח API בתהליך משותף

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

ההגדרה הבאה של תהליך משותף כוללת מדיניות Verify-API-Key שמופעלת כשקוראים לתהליך המשותף ממדיניות FlowCallout ב-proxy ל-API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SharedFlow name="default">
    <Step>
        <Name>Verify-API-Key</Name>
    </Step>
</SharedFlow>

המדיניות VerifyAPIKey בתהליך המשותף הקודם מאחזרת את ערך המפתח ומאמתת אותו.

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key">
    <DisplayName>Verify API Key</DisplayName>
    <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

מדיניות FlowCallout הבאה, שמשמשת ב-proxy ל-API, קוראת ל-תהליך משותף הקודם כדי לאמת את מפתח ה-API. חבילת ה-shared flow‏ verify-apikey-shared (לא מוצגת כאן) מגדירה את ה-shared flow באופן שבו חבילת APIProxy מגדירה proxy.

<FlowCallout async="false" continueOnError="false" enabled="true" name="Auth-Flow-Callout">
    <DisplayName>Auth Flow Callout</DisplayName>
    <SharedFlowBundle>verify-apikey-shared</SharedFlowBundle>
</FlowCallout>

העברת פרמטרים לתהליך משותף

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

1. ‫String-Handler FlowCallout policy קוראת ל-shared flow, ומעבירה פרמטרים שמציינים את המשתנה לאחסון הפלט של ה-shared flow, את הפעולה של ה-shared flow שבה רוצים להשתמש ואת הקלט שבו רוצים להשתמש (כאן, מחרוזת מילולית, אבל יכול להיות גם משתנה של flow). רכיבי Parameter מציינים את השמות והערכים של משתנים ליצירה בזמן ריצה. התהליך המשותף יכול לאחזר את המשתנים האלה כדי להשתמש בהם בקוד שלו.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
     <DisplayName>String Handler</DisplayName>
     <Parameters>
       <Parameter name="input">Gladys Kravitz</Parameter>
       <Parameter name="operations">concatenate tolowercase</Parameter>
       <Parameter name="outputVariable">string.handler.output</Parameter>
     </Parameters>
     <SharedFlowBundle>StringHandler</SharedFlowBundle>
   </FlowCallout>

2. הזרימה המשותפת default הבאה כוללת מדיניות JavaScript‏ SharedStringFunctions שמופעלת כשהזרימה המשותפת נקראת ממדיניות FlowCallout.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <SharedFlow name="default">
     <Step>
       <Name>SharedStringFunctions</Name>
     </Step>
   </SharedFlow>

3. בזרימת הנתונים המשותפת, מדיניות ה-JavaScript‏ SharedStringFunctions הבאה מציינת את קובץ ה-JavaScript‏ SharedStringFunctions.js עם הקוד להרצה.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="SharedStringFunctions">
     <DisplayName>SharedStringFunctions</DisplayName> <Properties/>
     <ResourceURL>jsc://SharedStringFunctions.js</ResourceURL>
   </Javascript>

4. קוד ה-JavaScript הבא, SharedStringFunctions.js, מופעל מתוך SharedStringFunctions מדיניות JavaScript. הסקריפט הזה מאחזר ערכים ממשתנים שנוצרו מרכיבי המדיניות FlowCallout Parameter.

   // Input value from the calling API proxy.
   var handledString = context.getVariable("input");
   // Variable to use for output from this script.
   var outputVariable = context.getVariable("outputVariable");
   // A space-separated list of things to do to the input string.
   // Convert to lower case to handle unintentional capitals in configuration.
   var operation = context.getVariable("operations").toLowerCase();
   
   // If "lowercase" was given as an operation, convert the input to lowercase.
   if (operation.includes("tolowercase")) {
       handledString = handledString.toLowerCase();
   }
   
   // If "concatenate" was given as an operation, concatenate the input.
   if (operation.includes("concatenate")) {
       handledString = handledString.replace(/\s+/g, '');
   }
   // Assign the resulting string to the output variable specified by
   // the calling API proxy.
   context.setVariable(outputVariable, handledString);

5. ההרצה חוזרת ממדיניות JavaScript, אל התהליך המשותף, ואז אל מדיניות FlowCallout ב-proxy ל-API המקורי.

תחביר

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

<!- A literal value in an attribute. --/>
<Parameter name="parameter-name" value='parameter-value' />
<!- A reference to a variable in an attribute. --/>
<Parameter name="parameter-name" ref='source-variable-name' />
<!- A literal value in the element content. --/>
<Parameter name="parameter-name">parameter-value</Parameter>
<!- An reference to an attribute in the element content. --/>
<Parameter name="parameter-name">{source-variable-name}</Parameter>

דוגמה

המדיניות String-Handler FlowCallout מעבירה פרמטרים שמציינים איפה לאחסן את הפלט של התהליך המשותף ואיזה קלט להשתמש. רכיבי Parameter מציינים את השמות והערכים של משתנים שייווצרו בזמן הריצה. התהליך המשותף יכול לאחזר את המשתנים האלה כדי להשתמש בהם בקוד שלו.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
  <DisplayName>String Handler</DisplayName>
  <Parameters>
    <Parameter name="input">Gladys Kravitz</Parameter>
    <Parameter name="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>

תחביר

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>