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

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

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

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

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

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

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

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

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

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

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

פיתוח תהליך משותף

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

אלה השלבים ברמה גבוהה לפיתוח תהליך עבודה משותף:

  1. קובעים מה תהיה קבוצת התכונות המשותפת.

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

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

    תהליך שיתופי הוא רצף של שלבים מותנים. לכן פיתוח של אחד מהם דומה לפיתוח של שרת 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>

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

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

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

    בדומה לשרתים proxy ל-API, אפשר לייבא קובץ zip שמכיל את הארטיפקטים של מקור התהליך המשותף (מידע נוסף על ייבוא שרתי 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 הניהול. זהו טופס הבקשה באמצעות ה-Management 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 באמצעות וו לזרימה, כפי שמתואר במאמר צירוף תהליך משותף באמצעות וו לזרימה). במדריך המבוא יצירת שרת ה-API הראשון מוסבר איך יוצרים שרת proxy ל-API.

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

    בקוד הבא, מדיניות של FlowCallout קוראת לתהליך שיתופי שנקרא 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 ולעקוב אחרי השרת.

    אלה השלבים:

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

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

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

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

  1. נכנסים לדף Shared Flows (תהליכים משותפים), כפי שמתואר בהמשך. בדף Shared Flows (תהליכים משותפים) אפשר לראות רשימה של תהליכים משותפים בארגון, ולערוך או למחוק תהליכים ברשימה.

    Edge

    כדי לגשת לדף Shared Flows באמצעות ממשק המשתמש של 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. בסרגל הניווט העליון, בוחרים באפשרות APIs‏ > Shared Flows.
  2. לוחצים על הלחצן + תהליך עבודה משותף כדי להתחיל להוסיף תהליך עבודה משותף חדש.
  3. בדף יצירת תהליך משותף, בוחרים את האופן שבו רוצים ליצור את התהליך החדש:
    • ליצור תהליך חדש מאפס. תוכלו להגדיר מדיניות ומשאבים כשלבים בתהליך.
      1. בוחרים באפשרות ריקון תהליך עבודה משותף.
      2. מזינים ערך שם. זה יהיה השם שבו שרתים proxy של API ותהליכים אחרים של תעבורת נתונים משותפת ישתמשו כדי להפנות לתהליך המשותף הזה. השם צריך להיות תיאורי למפתחים שעושים את התהליך.
      3. מזינים תיאור כדי לספק מידע נוסף על הפעולות שהתהליך מבצע.
      4. לוחצים על הבא.
      5. אפשר גם לבחור את הסביבות שבהן רוצים לפרוס את התהליך החדש.

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

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

    • כדי ליצור תהליך משותף ממקורות קיימים, צריך להעלות חבילת זרימה.
      1. בוחרים באפשרות Shared Flow Bundle כדי לציין קובץ zip שמכיל את הארטיפקטים שרוצים להוסיף לתהליך החדש.

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

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

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

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

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

ראה גם

שרשור בין שרתי proxy ל-API