שלב 6: צירוף מדיניות

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

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

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

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

בשלבים הבאים יוצרים מדיניות חדשה ומצרפים אותה ל-proxy ל-API בPreFlow response flow כדי לוודא שהמדיניות מוחלת לפני שמתבצע עיבוד אחר. מדיניות XMLtoJSON שבה נעשה שימוש במדריך הזה ממירה את מטען הייעודי (payload) של הודעת התגובה של ה-API מ-XML ל-JSON.

1. יוצרים מדיניות XMLtoJSON.
   1. מרחיבים את חבילת ה-proxy ל-API‏ helloworld, מעבירים את הסמן מעל התיקייה policies ולוחצים על .

      

      ייפתח האשף Create policy.

   2. בוחרים באפשרות גישור בתור קטגוריית המדיניות.
   3. בוחרים באפשרות XML to JSON בתור סוג המדיניות.
   4. מזינים XMLtoJSON בתור שם המדיניות ולוחצים על Enter.

      המדיניות נוספת לתיקייה /policies של ה-proxy ל-API ונפתחת בעורך.

   5. לוחצים על XMLtoJSON.xml כדי לערוך את המדיניות. מגדירים את הרכיבים <OutputVariable> ו-<Source> לערך response ושומרים את השינויים.
      הערה: בשלב הבא תצרפו את המדיניות לזרימת התגובה ב-PreFlow של proxy ל-API.

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <XMLToJSON async="false" continueOnError="false" enabled="true" name="XMLtoJSON">
          <DisplayName>XMLtoJSON</DisplayName>
          <Properties/>
          <Format>yahoo</Format>
          <OutputVariable>response</OutputVariable>
          <Source>response</Source>
      </XMLToJSON>

2. מצרפים את המדיניות לנקודת הקצה של שרת ה-proxy שמוגדרת כברירת מחדל.
   1. מרחיבים את התיקייה proxies בחבילת ה-proxy ל-API‏ helloworld ולוחצים על default.xml כדי לפתוח את הקובץ בעורך.
   2. מוסיפים רכיב <Step> שמפנה למדיניות XMLtoJSON לזרימת <Response> ב-proxy ל-API <PreFlow>:

      <ProxyEndpoint name="default">
         <PreFlow name="PreFlow">
            <Request>
               <Step>
                  <Name>verify-api-key</Name>
               </Step>
               <Step>
                  <Name>remove-query-param-apikey</Name>
               </Step>
               <Step>
                  <Name>impose-quota</Name>
               </Step>
            </Request>
            <Response>
               <Step>
                  <Name>XMLtoJSON</Name>
               </Step>
            </Response>
         </PreFlow>
       ...
      </ProxyEndpoint>

   3. שומרים את השינויים בקובץ.
3. כדי לפרוס מחדש את הסביבה, מעבירים את הסמן מעל תיקיית הסביבה dev ולוחצים על .

   

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

   

5. שולחים קריאה ל-API בכרטיסייה Terminal.

   curl 0:8998/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

   תגובת ה-XML מומרת ל-JSON, באופן הבא:

   {
     "root": {
       "city": "San Jose",
       "firstName": "John",
       "lastName": "Doe",
       "state": "CA"
     }
   }

מזל טוב! הצלחת לצרף את מדיניות XMLtoJSON ל-proxy ל-API!

לאחר מכן תפרסו את ה-API כארכיון בסביבת Apigee לבדיקות שילוב ולפרסום בייצור.

1 2 3 4 5 6 (הבא) שלב 7: פריסה בסביבת Apigee 8