הפניה לתצורה של חבילה משותפת

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

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

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

המבנה של חבילת התהליך המשותף

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

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

הרכיבים בטבלה שלמעלה מוגדרים על ידי קובצי התצורה במבנה הספריות הבא:

קובצי תצורה ומבנה הספרייה של חבילת תהליך משותפת

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

הגדרת בסיס

קובץ התצורה הבסיסי נמצא בספריית השורש של החבילה. השם זהה לשם של החבילה.

/sharedflowbundle/traffic-management-shared.xml

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

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

מאפיינים של תצורת בסיס

שם התיאור ברירת המחדל חובה?
SharedFlowBundle
name השם של חבילת התהליך המשותפת. השם חייב להיות ייחודי בארגון. התווים שמותר לכם להשתמש בהם בשם מוגבלים: A-Za-z0-9_- לא רלוונטי כן
revision מספר הגרסה הקודמת של הגדרת חבילת הזרימה המשותפת. אין צורך להגדיר במפורש את מספר הגרסה, מפני ש-Apigee Edge עוקב באופן אוטומטי אחר הגרסה הנוכחית של התהליך המשותף. לא רלוונטי לא

רכיבי תצורת בסיס

שם התיאור ברירת המחדל חובה?
SharedFlowBundle
ConfigurationVersion גרסת הסכימה של חבילת התהליכים המשותפת שהתהליך המשותף הזה תואם לה. הערך הנתמך היחיד בשלב זה הוא majorVersion 4 ו-minVersion 0. אפשר להשתמש בהגדרה הזו בעתיד כדי לאפשר את הפיתוח של פורמט חבילת התהליך המשותף. 4.0 לא
CreatedAt וגם CreatedBy התאריך/השעה (בתקופת המערכת) שבה נוצרה חבילת התהליך המשותפת, יחד עם כתובת האימייל של המשתמש שיצר אותה.
Description תיאור טקסטואלי של התהליך המשותף. אם הוספת תיאור, הוא יופיע בממשק המשתמש לניהול Edge. לא רלוונטי לא
DisplayName שם ידידותי למשתמש, שעשוי להיות שונה מהמאפיין name של הגדרת התהליך המשותף. לא רלוונטי לא
LastModifiedAt וגם LastModifiedBy התאריך/השעה (בתקופת המערכת) שבהם שונתה לאחרונה חבילת התהליך המשותפת, יחד עם האימייל של המשתמש ששינה אותה.
Policies רשימה של כללי מדיניות בספרייה /policies בתהליך המשותף הזה. הרכיב הזה יופיע בדרך כלל רק כשהתהליך המשותף נוצר באמצעות ממשק המשתמש לניהול Edge. זוהי פשוט הגדרת 'מניפסט' שנועדה לספק חשיפה של התוכן בזרימה המשותפת. לא רלוונטי לא
Resources רשימת משאבים (JavaScript, Python, Java, XSLT) בספרייה /resources בתהליך המשותף הזה. הרכיב הזה יופיע בדרך כלל רק כשהתהליך המשותף נוצר באמצעות ממשק המשתמש לניהול Edge. זוהי פשוט הגדרת 'מניפסט', שנועדה לספק חשיפה של התוכן בזרימה המשותפת. לא רלוונטי לא
SharedFlows מציין את התהליך המשותף שהחבילה הזו מכילה.

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

לא רלוונטי כן

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

/sharedflowbundle/sharedflows/default.xml

תצורת SharedFlow מגדירה את הרצף שבו יש לבצע את רכיבי הזרימה. גם רכיבי הצאצא <Step> של הרכיב <SharedFlow> מציינים חלק מהרצף, כמו קריאה למדיניות.

ההגדרה הבאה של SharedFlow מציינת שלושה כללי מדיניות שיש לבצע ברצף מלמעלה למטה (משמאל לימין במסוף הניהול), כאשר המדיניות 'Spike Arrest' מופיעה ראשונה והמדיניות של 'נכסי יתרונות מרכזיים של זרימה'.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

מאפיינים של הגדרת תהליך משותף

שם התיאור ברירת המחדל חובה?
SharedFlow
name השם של התהליך המשותף, והוא חייב להיות ייחודי בארגון. התווים שמותר לכם להשתמש בהם בשם מוגבלים: A-Za-z0-9_- לא רלוונטי כן
revision מספר הגרסה הקודמת של הגדרת הזרימה המשותפת. אין צורך להגדיר במפורש את מספר הגרסה, מכיוון ש-Apigee Edge עוקב באופן אוטומטי אחר הגרסה הנוכחית של התהליך המשותף. לא רלוונטי לא

רכיבי הגדרה של תהליך משותף

שם התיאור ברירת המחדל חובה?
SharedFlow מגדיר את הרצף של כללי המדיניות בתהליך המשותף. לא רלוונטי כן
Step מגדיר שלב – שלב ברצף של הזרימה. לא רלוונטי כן
Name מציין את שם הפריט שהשלב מפנה אליו. הערך של הרכיב הזה צריך להיות זהה למזהה הייחודי של הפריט, כמו ערך המאפיין של שם המדיניות. לא רלוונטי כן

כללי מדיניות

/sharedflowbundle/policies

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

מקורות מידע

/sharedflowbundle/resources

משאבים הם סקריפטים, קוד וטרנספורמציות XSL שאפשר לצרף לתהליכי עבודה משותפים באמצעות מדיניות. הם מופיעים בקטע 'סקריפטים' של עורך התהליך המשותף בממשק המשתמש של הניהול.

במאמר קובצי משאבים מפורטים סוגי המשאבים הנתמכים.

פרסום שאלות בפורום למפתחים של Apigee.