תהליכי עבודה משותפים לשימוש חוזר

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

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

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

בסרטון הבא מוסבר איך ליצור זרימה משותפת ולעקוב אחריה בממשק המשתמש של Edge.

הסרטון הבא, באורך 5 דקות, מדגים איך ליצור תהליך משותף ולעקוב אחריו בממשק המשתמש הקלאסי Edge (Edge לענן הפרטי בלבד).

ניתן להפעיל תהליך משותף באמצעות המדיניות 'הסבר על הזרימה'. בנוסף, על ידי צירוף של תהליך משותף לו-hook, אפשר להגדיר שהתהליך המשותף יתבצע לפני שרת proxy או בקשת יעד, או אחרי תגובה של שרת proxy או של יעד.

לעיון במדיניות בנושא יתרונות מרכזיים של זרימה, ניתן לעיין במדיניות 'נכסי יתרונות מרכזיים מהאתר'. למידע נוסף על קטעי הוק (hook) לזרימה, ראו איך מחברים תהליך משותף באמצעות קישור הוק (hook).

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

  • אבטחה, באמצעות קוד הרשאה באמצעות אימות מפתחות OAuth ו-API, וכן קוד הגנה מפני איומים.
  • לרישום ביומן, כדי ליצור הודעות שגיאה רגילות.
  • גישור, למעבר בין פורמטים של הודעות XML ו-JSON.

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

פיתוח זרימה משותפת

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

אלה השלבים העיקריים לפיתוח זרימה משותפת:

  1. עליך להבין מהי קבוצת התכונות המשותפת.

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

  2. מפתחים תהליך משותף על ידי הטמעת מדיניות ומשאבים תומכים, בדיוק כמו בפיתוח של שרת proxy ל-API.

    תהליך משותף הוא רצף של שלבים מותנים. לכן, פיתוח שרת proxy הוא כמו פיתוח של שרת proxy ל-API. אפשר לכלול כללי מדיניות ומשאבים שאפשר לכלול בשרת proxy.

    לדוגמה, כחלק מהתמיכה בניהול תעבורת הנתונים, ניתן להטמיע מדיניות של Spike Arrest כדי לאפשר רק 30 בקשות בשנייה, כמו בדוגמה הבאה:

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
    <DisplayName>Spike Arrest</DisplayName>
    <Properties/>
    <Identifier ref="request.header.some-header-name"/>
    <MessageWeight ref="request.header.weight"/>
    <Rate>30ps</Rate>
</SpikeArrest>

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

    <SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
</SharedFlow>

    למידע על התחלת תהליך משותף במסוף הניהול, ראו יצירת תהליך משותף בממשק המשתמש של Edge.

    כמו בשרתי proxy של API, אפשר לייבא קובץ ZIP שמכיל את פריטי המידע שנוצרו בתהליך הפיתוח (Artifact) של מקור התהליך המשותף (מידע נוסף על ייבוא שרתי proxy זמין במאמר ייבוא שרת proxy חדש ל-API). בדוגמה הבאה מוסבר איך לייבא תהליך משותף באמצעות ה-Management API:

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. פורסים את התהליך המשותף בסביבה לפני שפורסים שרתי proxy או תהליכי עבודה משותפים שישתמשו בו. פורסים תהליך משותף באותו אופן שבו פורסים שרת proxy ל-API. (למידע נוסף, ראו סקירה כללית על הפריסה).

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

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

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

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

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  4. מפתחים את שרת ה-proxy הצורך של ה-API כדי שיוכל לקרוא לתהליך המשותף כחלק מהתהליך שלו.

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

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

    בקטע הבא, המדיניות של הסבר על זרימה מתייחסת לתהליך משותף שנקרא traffic-management-shared.

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
    <DisplayName>Traffic Management FlowCallout</DisplayName>
    <Properties/>
    <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
</FlowCallout>

    למידע נוסף, תוכלו לקרוא את המאמר קריאות לתהליך משותף משרת proxy של API או מתהליך משותף

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

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

    אלה השלבים:

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

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

יצירת תהליך משותף בממשק המשתמש של Edge

כשמשתמשים בממשק המשתמש של Apigee Edge כדי ליצור תהליך משותף, אפשר ליצור תהליך מאפס או לייבא מקורות זרימה קיימים כקובץ ZIP של חבילת זרימה.

  1. ניתן לגשת לדף 'זרימות משותפות' כפי שמתואר בהמשך. בדף 'זרימות משותפות' ניתן להציג רשימה של תהליכי עבודה משותפים בארגון, ולערוך או למחוק ברשימה תהליכי עבודה משותפים.

    Edge

    כדי לגשת לדף 'זרימות משותפות' באמצעות ממשק המשתמש של Edge:

    1. נכנסים לאתר apigee.com/edge.
    2. בוחרים את הארגון שכולל את התהליך המשותף. למידע נוסף, ראו מעבר בין הארגונים.

      התהליך המשותף יהיה זמין לכל שרת proxy של API ותהליכי עבודה משותפים שנפרסו בסביבה מהארגון הזה. התוכן לא יהיה זמין מחוץ לארגון הזה.

    3. בחר פיתוח > זרימות משותפות בסרגל הניווט הימני.

    Classic Edge (ענן פרטי)

    כדי לגשת לדף 'זרימות משותפות' באמצעות ממשק המשתמש הקלאסי Edge:

    1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
    2. בוחרים את הארגון שכולל את התהליך המשותף. למידע נוסף, ראו מעבר בין הארגונים.

      התהליך המשותף יהיה זמין לכל שרת proxy של API ותהליכי עבודה משותפים שנפרסו בסביבה מהארגון הזה. התוכן לא יהיה זמין מחוץ לארגון הזה.

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

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

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

    • כדי ליצור תהליך משותף ממקורות קיימים, צריך להעלות חבילת זרימה.
      1. בוחרים באפשרות Sharedflow Bundle כדי לציין קובץ ZIP שמכיל את פריטי המידע שנוצרו בתהליך הפיתוח (Artifact) שרוצים לכלול בתהליך החדש.

        חבילת זרימה משותפת מכילה את פריטי המקור שנוצרו בתהליך הפיתוח (Artifact) של זרימה משותפת. לדוגמה, אם מורידים תהליך משותף מממשק המשתמש של Edge, נוצר קובץ ZIP עם חבילת הזרימה.

      2. לוחצים על הבא.
      3. לוחצים על בחירת קובץ כדי לחפש את קובץ ה-ZIP שמכיל את מקורות התהליך המשותפים שרוצים לייבא.
      4. בתיבה שם זרימה משותפת, הזן שם לזרימה המיובאת. זה יהיה השם שישמש שרתי proxy של API ותהליכי עבודה משותפים אחרים לצורך הפניה לתהליך המשותף הזה. השם צריך להיות תיאורי למפתחים שמנצלים את התהליך.
      5. לוחצים על הבא.
      6. לוחצים על יצירה כדי ליצור את התהליך החדש מהמקורות שאתם מייבאים.

קריאה לתהליך משותף משרת proxy של API או מתהליך משותף

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

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

כדאי לעיין גם בפרטים הבאים

שרשור של שרתי proxy של API יחד