מדיניות HTTPModifier

מדיניות רגילה

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

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

המדיניות HTTPModifier משנה הודעת בקשה או תגובה קיימת.

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

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

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

‫

מדיניות HTTPModifier יכולה ליצור משתני זרימה עם רכיבי הצאצא הבאים:

הסדר שבו מארגנים את הרכיבים <Add>, <Set> ו-<Remove> חשוב. המדיניות מבצעת את הפעולות האלה לפי הסדר שבו הן מופיעות בהגדרת המדיניות. אם רוצים להסיר את כל הכותרות, צריך להגדיר כותרת ספציפית ולכלול את הרכיב <Remove> לפני הרכיב <Set>.

המדיניות הזו היא מדיניות רגילה ואפשר לפרוס אותה בכל סוג של סביבה. מידע על סוגי המדיניות והזמינות שלהם בכל סוג סביבה זמין במאמר סוגי מדיניות.

תרחישים לדוגמה

יש הרבה מצבים שבהם כדאי לשנות בקשה או הודעת תגובה במהלך העיבוד ב-Apigee. לדוגמה:

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

רכיב `<HTTPModifier>`

הגדרה של מדיניות HTTPModifier.

ערך ברירת המחדל	מידע נוסף מופיע בכרטיסייה מדיניות ברירת המחדל שבהמשך
חובה?	חובה
סוג	אובייקט מורכב
רכיב אב	לא רלוונטי
רכיבי צאצא	`<Add>` `<AssignTo>` `<DisplayName>` `<IgnoreUnresolvedVariables>` `<Remove>` `<Set>`

רכיב <HTTPModifier> משתמש בתחביר הבא:

תחביר

רכיב <HTTPModifier> משתמש בתחביר הבא:

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- All HTTPModifier child elements are optional -->
  <Add>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Add>

  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">DESTINATION_VARIABLE_NAME</AssignTo>

  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>

  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all FormParams (<FormParams/>) -->
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array to remove all Headers (<Headers/>) -->
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <!-- Can also be an empty array to remove all QueryParams (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Remove>

  <Set>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <Path>PATH</Path>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
    <StatusCode>HTTP_STATUS_CODE or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>

</HTTPModifier>

מדיניות ברירת המחדל

בדוגמה הבאה מוצגות הגדרות ברירת המחדל כשמוסיפים מדיניות HTTPModifier לזרימה בממשק המשתמש של Apigee:

<HTTPModifier continueOnError="false" enabled="true" name="http-modifier-default">
  <DisplayName>HTTP Modifier-1</DisplayName>
  <Properties/>
  <Remove>
    <Headers>
      <Header name="h1"/>
    </Headers>
    <QueryParams>
      <QueryParam name="q1"/>
    </QueryParams>
    <FormParams>
      <FormParam name="f1"/>
    </FormParams>
  </Remove>
  <Add>
    <Headers/>
    <QueryParams/>
    <FormParams/>
  </Add>
  <Set>
    <Headers/>
    <QueryParams/>
    <FormParams/>
    <!-- <Verb>GET</Verb> -->
    <Path/>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</HTTPModifier>

כשמוסיפים מדיניות חדשה של HTTPModifier בממשק המשתמש של Apigee, התבנית מכילה stub לכל הפעולות האפשריות. בדרך כלל, בוחרים את הפעולות שרוצים לבצע באמצעות המדיניות הזו ומסירים את שאר רכיבי הצאצא. לדוגמה, אם רוצים לבצע פעולת הוספה, משתמשים ברכיב <Add> ומסירים את הרכיב <Remove> ורכיבים משניים אחרים מהמדיניות כדי שהיא תהיה קריאה יותר.

לרכיב הזה יש את המאפיינים הבאים שמשותפים לכל המדיניות:

מאפיין	ברירת מחדל	חובה?	תיאור
`name`	לא רלוונטי	חובה	השם הפנימי של המדיניות. הערך של מאפיין `name` יכול להכיל אותיות, מספרים, רווחים, מקפים, קווים תחתונים ונקודות. הערך הזה לא יכול לחרוג מ-255 תווים. אפשר להשתמש ברכיב `<DisplayName>` כדי לתת למדיניות תווית בשם אחר בשפה טבעית בכלי לעריכת פרוקסי בממשק הניהול.
`continueOnError`	FALSE	אופציונלי	מגדירים את הערך `false` כדי להחזיר שגיאה אם המדיניות נכשלת. זו התנהגות צפויה ברוב המקרים. הגדרה ל-`true` מאפשרת להמשיך את הביצוע של התהליך גם אחרי שמדיניות נכשלת. מאמרים קשורים: הפעלת כללי תקלות מתבצעת רק במצב שגיאה (מידע על continueOnError) טיפול בתקלות בתהליך הנוכחי
`enabled`	TRUE	אופציונלי	מגדירים את המדיניות למצב `true` כדי לאכוף אותה. מגדירים את הערך `false` כדי להשבית את המדיניות. המדיניות לא תיאכף גם אם היא תישאר מצורפת לזרימה.
`async`	FALSE	הוצא משימוש	המאפיין הזה הוצא משימוש.

בטבלה הבאה מופיע תיאור כללי של רכיבי הצאצא של <HTTPModifier>:

רכיב צאצא	חובה?	תיאור
פעולות נפוצות
`<Add>`	אופציונלי	הוספת מידע לאובייקט של ההודעה שצוין ברכיב `<AssignTo>`. ‫`<Add>` מוסיף כותרות או פרמטרים להודעה שלא קיימים בהודעה המקורית. שימו לב שגם `<Set>` מספק את הפונקציונליות הזו. כדי להחליף כותרות או פרמטרים קיימים, משתמשים ברכיב `<Set>`.
`<Remove>`	אופציונלי	מוחק את הרכיבים שצוינו ממשתנה ההודעה שצוין ברכיב `<AssignTo>`.
`<Set>`	אופציונלי	הפונקציה מחליפה ערכים של מאפיינים קיימים בבקשה או בתגובה, שמוגדרים על ידי הרכיב `<AssignTo>`. ‫`<Set>` מחליף כותרות או פרמטרים שכבר קיימים בהודעה המקורית, או מוסיף חדשים אם הם לא קיימים.
רכיבי צאצא אחרים
`<AssignTo>`	אופציונלי	מציינת על איזו הודעה חלה מדיניות HTTPModifier. יכול להיות שמדובר בבקשה או בתגובה רגילות, או בהודעה חדשה בהתאמה אישית.
`<IgnoreUnresolvedVariables>`	אופציונלי	קובעת אם העיבוד ייפסק כשנתקלים במשתנה לא פתור.

כל אחד מרכיבי הצאצא האלה מתואר בקטעים הבאים.

דוגמאות

בדוגמאות הבאות מוצגות כמה מהדרכים שבהן אפשר להשתמש במדיניות HTTPModifier:

‫1: הוספת כותרת

בדוגמה הבאה מוסיפים כותרת לבקשה באמצעות הרכיב <Add>. המשתנה VerifyAPIKey בדוגמה הזו נוצר על ידי מדיניות VerifyAPIKey:

<HTTPModifier name="HM-add-headers-1">
  <Add>
    <Headers>
      <Header name="partner-id">{verifyapikey.VAK-1.developer.app.partner-id}</Header>
    </Headers>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

‫2: שינוי התשובה

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

<HTTPModifier name="HM-modify-response">
  <Set>
    <Headers>
      <Header name="Cache-Hit">{lookupcache.LookupCache-1.cachehit}</Header>
    </Headers>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignTo>response</AssignTo>
</HTTPModifier>

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

בדוגמה הזו, השם של המשתנה הוא response ברכיב <AssignTo>, ולכן המדיניות הזו משנה את אובייקט התגובה שהוגדר במקור עם נתונים שהוחזרו על ידי שרת היעד.

כותרת ה-HTTP שנוספת להודעת התגובה על ידי המדיניות הזו נגזרת ממשתנה שאוכלס על ידי מדיניות LookupCache. לכן, הודעת התגובה ששונתה על ידי מדיניות HTTPModifier הזו מכילה כותרת HTTP שמציינת אם התוצאות נמשכו מהמטמון או לא. הגדרת כותרות בתגובה יכולה להיות שימושית לניפוי באגים ולפתרון בעיות.

‫3: הסרת פרמטר של שאילתה

בדוגמה הבאה, פרמטר השאילתה apikey מוסר מהבקשה:

<HTTPModifier name="HM-remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

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

הפניה לרכיב צאצא

בקטע הזה מתוארים רכיבי הבן של <HTTPModifier>.

`<Add>`

מוסיף מידע לבקשה או לתשובה, שמוגדר על ידי הרכיב <AssignTo>.

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

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	סוג מורכב
רכיב אב	`<HTTPModifier>`
רכיבי צאצא	`<FormParams>` `<Headers>` `<QueryParams>`

רכיב <Add> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Add>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה נעשה שימוש ברכיב <FormParams> כדי לקבל את הערכים של שלושה פרמטרים של מחרוזת שאילתה מהבקשה הראשונית ולהגדיר אותם כפרמטרים של טופס בבקשה של נקודת היעד:

<HTTPModifier name="HM-add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="username">{request.queryparam.name}</FormParam>
      <FormParam name="zip_code">{request.queryparam.zipCode}</FormParam>
      <FormParam name="default_language">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <Remove>
    <QueryParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

בדוגמה הבאה נעשה שימוש ברכיב <Headers> כדי להוסיף כותרת partner-id לבקשה שתישלח לנקודת הקצה של היעד:

<HTTPModifier name="HM-add-headers-1">
  <Add>
    <Headers>
      <Header name="partner-id">{verifyapikey.VAK-1.developer.app.partner-id}</Header>
    </Headers>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 3

בדוגמה הבאה נעשה שימוש ברכיב <QueryParams> כדי להוסיף לבקשה פרמטר יחיד של שאילתה עם ערך סטטי:

<HTTPModifier name="HM-add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

בדוגמה הזו נעשה שימוש ב-<Add> בתהליך המקדים של הבקשה. אם בודקים את התוצאות בכלי כמו כלי הניפוי באגים, הבקשה אל https://example-target.com/get הופכת ל-https://example-target.com/get?myParam=42.

רכיבי הצאצא של <Add> תומכים בהחלפת מחרוזות דינמית, שנקראת תבניות הודעות.

`<FormParams>` (ילד/ה של `<Add>`)

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

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של `<FormParam>` רכיבים
רכיב אב	`<Add>`
רכיבי צאצא	`<FormParam>`

רכיב <FormParams> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">DESTINATION_VARIABLE_NAME</AssignTo>
  </Add>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה מתווסף ל-request פרמטר טופס יחיד (answer) וערך סטטי (42):

<HTTPModifier name="HM-add-formparams-1">
  <Add>
    <FormParams>
      <FormParam name="answer">42</FormParam>
    </FormParams>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

בדוגמה הבאה מקבלים את הערך של פרמטר השאילתה name, מוסיפים אותו לבקשה כפרמטר של טופס ואז מסירים את פרמטר השאילתה:

<HTTPModifier name="HM-Swap-QueryParam-to-FormParams">
  <Add>
    <FormParam name="name">{request.queryparam.name}
  </Add>
  <Remove>
    <QueryParam name="name"/>
  </Remove>
</HTTPModifier>

שימו לב שבמקרה הזה לא צוין יעד עם <AssignTo>. המדיניות הזו מוסיפה את הפרמטר לבקשה בלבד.

דוגמה 3

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

<HTTPModifier name="HM-add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="username">{request.queryparam.name}</FormParam>
      <FormParam name="zip_code">{request.queryparam.zipCode}</FormParam>
      <FormParam name="default_language">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <Remove>
    <QueryParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

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

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

username=nick&zip_code=90210&default_language=en

אפשר להשתמש ב-<FormParams> רק אם מתקיימים הקריטריונים הבאים:

פעלים של HTTP: ‏ GET, POST
סוג ההודעה: בקשה
אחת (או שתי) מהאפשרויות הבאות:
- נתוני טופס: צריך להגדיר ערך כלשהו או "" (המחרוזת הריקה). לדוגמה, אם רוצים להוסיף את -d "" לבקשה, כותבים curl.
- כותרת Content-Length: מוגדרת ל-0 (אם אין נתונים בבקשה המקורית, אחרת, האורך הנוכחי, בבייטים). לדוגמה, אם רוצים להוסיף את הפקודה curl add -H "Content-Length: 0" לבקשה.

לדוגמה:

curl -vL -X POST -d "" -H "Content-Type: application/x-www-form-urlencoded"
  https://ahamilton-eval-test.apigee.net/am-test

כשמוסיפים את <FormParams>, ‏ Apigee מגדיר את הכותרת Content-Type של הבקשה לערך application/x-www-form-urlencoded לפני שליחת ההודעה לשירות היעד.

`<Headers>` (ילד/ה של `<Add>`)

הפעולה מוסיפה כותרות חדשות לבקשה או לתגובה שצוינו, באמצעות הרכיב <AssignTo>.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של `<Header>` רכיבים
רכיב אב	`<Add>`
רכיבי צאצא	`<Header>`

רכיב <Headers> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
  </Add>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה מוסיפים כותרת partner-id להודעת הבקשה, ומקצים לכותרת הזו את הערך של משתנה הזרימה verifyapikey.VAK-1.developer.app.partner-id.

<HTTPModifier name="HM-add-headers-1">
  <Add>
    <Headers>
      <Header name="partner-id">{verifyapikey.VAK-1.developer.app.partner-id}</Header>
    </Headers>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

`<QueryParams>` (ילד/ה של `<Add>`)

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

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של `<QueryParam>` רכיבים
רכיב אב	`<Add>`
רכיבי צאצא	`<QueryParam>`

רכיב <QueryParams> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Add>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, פרמטר השאילתה myParam מתווסף לבקשה והערך 42 מוקצה לו:

<HTTPModifier name="HM-add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

אפשר להשתמש ב-<QueryParams> רק אם מתקיימים הקריטריונים הבאים:

פעלים של HTTP: ‏ GET, POST
סוג ההודעה: בקשה

בנוסף, אפשר להגדיר פרמטרים של שאילתה רק כשהמאפיין type של רכיב <AssignTo> הוא הודעת בקשה. הגדרתם בתגובה לא משפיעה.

אם מגדירים במדיניות מערך ריק של פרמטרים של שאילתה (<Add><QueryParams/></Add>), המדיניות לא מוסיפה פרמטרים של שאילתה. התוצאה זהה להשמטת <QueryParams>.

`<AssignTo>`

קובעת על איזה אובייקט חלה מדיניות HTTPModifier. האפשרויות הן:

הודעת הבקשה: request שהתקבלה על ידי proxy ל-API
הודעת התגובה: response שהוחזרה משרת היעד
הודעה מותאמת אישית: אובייקט מותאם אישית של בקשה או תגובה

שימו לב שבמקרים מסוימים אי אפשר לשנות את האובייקט שעליו חלה מדיניות HTTPModifier. לדוגמה, אי אפשר להשתמש ב-<Add> או ב-<Set> כדי להוסיף או לשנות פרמטרים של שאילתה (<QueryParams>) או פרמטרים של טופס (<FormParams>) בתגובה. אפשר לשנות רק את הפרמטרים של השאילתה ואת הפרמטרים של הטופס בבקשה.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	String
רכיב אב	`<HTTPModifier>`
רכיבי צאצא	ללא

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

רכיב <AssignTo> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">DESTINATION_VARIABLE_NAME</AssignTo>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה לא מצוינת הודעה בטקסט של <AssignTo>. המשמעות היא שהמדיניות תחול על ההודעה request או על ההודעה response, בהתאם למקום שבו המדיניות מופעלת.

<HTTPModifier name="assignto-1">
  <AssignTo createNew="false" transport="http" type="request"/>-- no-op -->
  ...
</HTTPModifier>

אם מציינים createNew="false" ולא מספקים שם הודעה באופן מפורש, המאפיינים האחרים של <AssignTo> לא רלוונטיים. במקרה כזה, כדאי להשמיט לגמרי את הרכיב <AssignTo>.

דוגמה 2

בדוגמה הבאה נוצר אובייקט בקשה חדש, שדורס את האובייקט הקיים:

<HTTPModifier name="assignto-2">
  <AssignTo createNew="true" transport="http" type="request"/>
  ...
</HTTPModifier>

כשיוצרים אובייקט בקשה או תגובה חדש, הרכיבים האחרים של מדיניות HTTPModifier (כמו <Add> ו-<Set>) פועלים על אובייקט הבקשה החדש הזה.

אפשר לגשת לאובייקט הבקשה החדש במדיניות אחרת בהמשך התהליך, או לשלוח את אובייקט הבקשה החדש לשירות חיצוני באמצעות מדיניות ServiceCallout.

דוגמה 3

בדוגמה הבאה נוצר אובייקט בקשה חדש בשם MyRequestObject:

<HTTPModifier name="assignto-3">
  <AssignTo createNew="true" transport="http" type="request">MyRequestObject</AssignTo>
  ...
</HTTPModifier>

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

בטבלה הבאה מתוארים המאפיינים של <AssignTo>:

מאפיין תיאור חובה? סוג

מאפיין	תיאור	חובה?	סוג
`createNew`	קובעת אם המדיניות הזו יוצרת הודעה חדשה כשמגדירים ערכים. אם הערך הוא `true`, המדיניות יוצרת משתנה חדש מהסוג שצוין על ידי `type` (`request` או `response`). אם לא מציינים את השם של המשתנה החדש, המדיניות יוצרת אובייקט חדש של בקשה או תגובה, בהתאם לערך של `type`. זהירות: כשיוצרים אובייקט בקשה או תגובה חדש, אובייקט הבקשה או התגובה הקיים נמחק ומוחלף בחדש, כלומר כל המידע באובייקט אובד. אם `false`, המדיניות מגיבה באחת משתי דרכים: אם `<AssignTo>` יכול לפתור את שם המשתנה לבקשה או לתגובה, הוא ממשיך בעיבוד. לדוגמה, אם המדיניות נמצאת בתהליך של בקשה, המשתנה הוא אובייקט הבקשה. אם המדיניות נמצאת בתגובה, המשתנה הוא אובייקט התגובה. אם אי אפשר לפתור את `<AssignTo>`, או אם הוא נפתר לסוג שאינו הודעה, המדיניות מחזירה שגיאה. אם לא מציינים את `createNew`, המדיניות מגיבה באחת משתי דרכים: אם `<AssignTo>` מוביל להודעה, העיבוד עובר לשלב הבא. אם לא ניתן לפתור את `<AssignTo>`, או אם הוא נפתר לסוג שאינו הודעה, נוצר משתנה חדש מהסוג שצוין ב-`type`.	אופציונלי	בוליאני
`transport`	מציין את סוג התעבורה של סוג ההודעה של הבקשה או התגובה. ערך ברירת המחדל הוא `http` (הערך הנתמך היחיד).	אופציונלי	String
`type`	מציין את סוג ההודעה החדשה, כאשר `createNew` הוא `true`. הערכים התקינים הם `request` או `response`. ערך ברירת המחדל הוא `request`. אם לא מציינים את המאפיין הזה, Apigee יוצר בקשה או תגובה, בהתאם למיקום שבו המדיניות הזו מופעלת בתהליך.	אופציונלי	String

createNew

קובעת אם המדיניות הזו יוצרת הודעה חדשה כשמגדירים ערכים.

אם הערך הוא true, המדיניות יוצרת משתנה חדש מהסוג שצוין על ידי type (request או response). אם לא מציינים את השם של המשתנה החדש, המדיניות יוצרת אובייקט חדש של בקשה או תגובה, בהתאם לערך של type.

אם false, המדיניות מגיבה באחת משתי דרכים:

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

אם לא מציינים את createNew, המדיניות מגיבה באחת משתי דרכים:

אם <AssignTo> מוביל להודעה, העיבוד עובר לשלב הבא.
אם לא ניתן לפתור את <AssignTo>, או אם הוא נפתר לסוג שאינו הודעה, נוצר משתנה חדש מהסוג שצוין ב-type.

אופציונלי

בוליאני

transport

מציין את סוג התעבורה של סוג ההודעה של הבקשה או התגובה.

ערך ברירת המחדל הוא http (הערך הנתמך היחיד).

אופציונלי

String

type

מציין את סוג ההודעה החדשה, כאשר createNew הוא true. הערכים התקינים הם request או response.

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

אופציונלי

String

`<DisplayName>`

אפשר להשתמש במאפיין הזה בנוסף למאפיין name כדי לתת למדיניות שם אחר, שנשמע יותר טבעי, ב-UI של ניהול עריכת ה-proxy.

הרכיב <DisplayName> משותף לכל סוגי המדיניות.

ערך ברירת המחדל	לא רלוונטי
חובה?	זה שינוי אופציונלי. אם לא מציינים את `<DisplayName>`, המערכת משתמשת בערך של מאפיין `name` של המדיניות.
סוג	String
רכיב אב	<`PolicyElement`>
רכיבי צאצא	ללא

רכיב <DisplayName> משתמש בתחביר הבא:

תחביר

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

דוגמה

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

לרכיב <DisplayName> אין מאפיינים או רכיבי צאצא.

`<IgnoreUnresolvedVariables>`

קובעת אם העיבוד ייפסק כשנתקלים במשתנה לא פתור.

ערך ברירת המחדל	לא נכון
חובה?	אופציונלי
סוג	בוליאני
רכיב אב	`<HTTPModifier>`
רכיבי צאצא	ללא

הערך true גורם להתעלמות ממשתנים שלא נפתרו ולהמשך העיבוד. אחרת false. ערך ברירת המחדל הוא false.

ההגדרה של <IgnoreUnresolvedVariables> ל-true שונה מההגדרה של <HTTPModifier>'s continueOnError ל-true, כי היא ספציפית להגדרה ולקבלת ערכים של משתנים. אם מגדירים את continueOnError ל-true, מערכת Apigee מתעלמת מכל השגיאות, ולא רק משגיאות שמתרחשות כשמשתמשים במשתנים.

רכיב <IgnoreUnresolvedVariables> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, הערך של <IgnoreUnresolvedVariables> מוגדר ל-true:

<HTTPModifier name="HM-Set-Headers">
  <Set>
    <Headers>
      <Header name='new-header'>{possibly-defined-variable}<Header>
    </Headers>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</HTTPModifier>

מכיוון שהערך של <IgnoreUnresolvedVariables> מוגדר כ-true, אם המשתנה possibly-defined-variable לא מוגדר, המדיניות הזו לא תגרום לשגיאה.

`<Remove>`

הסרת כותרות, פרמטרים של שאילתות או פרמטרים של טפסים מהודעה. תג ריק מסיר את כל הפרמטרים התואמים, כולל headers, ‏ formparams ו-queryparams.

ההודעה המושפעת יכולה להיות בקשה או תגובה. כדי לציין על איזו הודעה <Remove> פועל הרכיב, משתמשים ברכיב <AssignTo>.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	סוג מורכב
רכיב אב	`<HTTPModifier>`
רכיבי צאצא	`<FormParams>` `<Headers>` `<QueryParams>`

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

רכיב <Remove> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all FormParams (<FormParams/>) -->
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array to remove all Headers (<Headers/>) -->
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <!-- Can also be an empty array to remove all QueryParams (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Remove>
</HTTPModifier>

דוגמה 1

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

<HTTPModifier name="HM-remove-2">
  <Remove>
    <!-- Empty (<FormParams/>) removes all form parameters -->
    <FormParams/>
    <QueryParams>
      <QueryParam name="qp1"/>
    </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

בדוגמה הבאה מוסר כל התוכן מאובייקט של הודעה:

<HTTPModifier name="HM-remove-3">
  <Remove/>
  <AssignTo>request</AssignTo>
</HTTPModifier>

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

`<FormParams>` (ילד/ה של `<Remove>`)

מסיר מהבקשה את הפרמטרים שצוינו בטופס. לרכיב הזה אין השפעה על התשובה.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של רכיבי `<FormParam>` או מערך ריק
רכיב אב	`<Remove>`
רכיבי צאצא	`<FormParam>`

רכיב <FormParams> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all FormParams (<FormParams/>) -->
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
  </Remove>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, שלושה פרמטרים של טופס מוסרים מהבקשה:

<HTTPModifier name="HM-remove-formparams-1">
  <Remove>
    <FormParams>
      <FormParam name="form_param_1"/>
      <FormParam name="form_param_2"/>
      <FormParam name="form_param_3"/>
    </FormParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

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

<HTTPModifier name="HM-remove-formparams-2">
  <Remove>
    <FormParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 3

אם יש כמה פרמטרים של טופס עם אותו שם, משתמשים בתחביר הבא:

<HTTPModifier name="HM-remove-formparams-3">
  <Remove>
    <FormParams>
      <FormParam name="f1"/>
      <FormParam name="f2"/>
      <FormParam name="f3.2"/>
    </FormParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

בדוגמה הזו, הערכים f1 ו-f2 והערך השני של f3 יוסרו. אם f3 מכיל רק ערך אחד, הוא לא יוסר.

אפשר להשתמש ב-<FormParams> רק אם מתקיימים הקריטריונים הבאים:

סוג ההודעה: בקשה
Content-Type: application/x-www-form-urlencoded

`<Headers>` (ילד/ה של `<Remove>`)

הפעולה מסירה את כותרות ה-HTTP שצוינו מהבקשה או מהתגובה, שמוגדרות על ידי הרכיב <AssignTo>.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של רכיבי `<Header>` או מערך ריק
רכיב אב	`<Remove>`
רכיבי צאצא	`<Header>`

רכיב <Headers> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all Headers (<Headers/>) -->
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
  </Remove>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, הכותרת user-agent מוסרת מהבקשה:

<HTTPModifier name="HM-remove-one-header">
  <Remove>
    <Headers>
      <Header name="user-agent"/>
    </Headers>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

בדוגמה הבאה, כל הכותרות מוסרות מהבקשה:

<HTTPModifier name="HM-remove-all-headers">
  <Remove>
    <Headers/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 3

אם יש כמה כותרות עם אותו שם, משתמשים בתחביר הבא:

<HTTPModifier name="HM-remove-headers-3">
  <Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

בדוגמה הזו, הערכים h1, h2 והערך השני של h3 מוסרים מהבקשה. אם h3 כולל רק ערך אחד, הוא לא יוסר.

`<QueryParams>` (ילד/ה של `<Remove>`)

הפונקציה מסירה מהבקשה את הפרמטרים שצוינו של השאילתה. לרכיב הזה אין השפעה על התשובה.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של רכיבי `<QueryParam>` או מערך ריק
רכיב אב	`<Remove>`
רכיבי צאצא	`<QueryParam>`

רכיב <QueryParams> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all QueryParams (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Remove>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה מוסר פרמטר שאילתה יחיד מהבקשה:

<HTTPModifier name="HM-remove-queryparams-1">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
      </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

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

<HTTPModifier name="HM-remove-queryparams-2">
  &tl;Remove>
      <QueryParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 3

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

<HTTPModifier name="HM-remove-queryparams-3">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
        <QueryParam name="qp2"/>
        <QueryParam name="qp3.2"/>
      </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

בדוגמה הזו, הערכים qp1, qp2 והערך השני של qp3 מוסרים מהבקשה. אם ל-qp3 יש רק ערך אחד, הוא לא יוסר.

דוגמה 4

בדוגמה הבאה, פרמטר השאילתה apikey מוסר מהבקשה:

<HTTPModifier name="HM-remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

אפשר להשתמש ב-<QueryParams> רק אם מתקיימים הקריטריונים הבאים:

פעלים של HTTP: ‏ GET, POST
סוג ההודעה: בקשה

`<Set>`

הגדרת מידע בהודעת הבקשה או התגובה, שמוגדר על ידי הרכיב <AssignTo>. ‫<Set> מחליף כותרות או פרמטרים של שאילתות או טפסים שכבר קיימים בהודעה המקורית, או מוסיף חדשים אם הם לא קיימים.

כותרות ופרמטרים של שאילתות וטפסים בהודעת HTTP יכולים להכיל כמה ערכים. כדי להוסיף ערכים נוספים לכותרת או לפרמטר, צריך להשתמש ברכיב <Add>.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	סוג מורכב
רכיב אב	`<HTTPModifier>`
רכיבי צאצא	`<FormParams>` `<Headers>` `<Path>` `<QueryParams>` `<StatusCode>` `<Verb>` `<Version>`

הערה: רכיבי המשנה של <Set> תומכים בתכונה של החלפת מחרוזות דינמית שנקראת תבניות הודעות.

רכיב <Set> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <Path>PATH</Path>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
    <StatusCode>HTTP_STATUS_CODE or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</HTTPModifier>

דוגמה

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

<HTTPModifier name="HM-Set-Header">
  <Set>
    <Headers>
        <Header name="authenticated-developer">{verifyapikey.VAK-1.developer.id}</Header>
    </Headers>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

`<FormParams>` (ילד/ה של `<Set>`)

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

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של `<FormParam>` רכיבים
רכיב אב	`<Set>`
רכיבי צאצא	`<FormParam>`

רכיב <FormParams> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
  </Set>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה מוגדר פרמטר של טופס בשם myparam לערך של המשתנה request.header.myparam בבקשה מותאמת אישית חדשה:

<HTTPModifier name="HM-set-formparams-1">
  <Set>
    <FormParams>
      <FormParam name="myparam">{request.header.myparam}</FormParam>
    </FormParams>
  </Set>
  <AssignTo createNew="true" transport="http" type="request>>MyCustomRequest</AssignTo>
</HTTPModifier>

אפשר להשתמש ב-<FormParams> רק אם מתקיימים הקריטריונים הבאים:

פועל HTTP: ‏ POST
סוג ההודעה: בקשה

אם מגדירים פרמטרים ריקים של טופס במדיניות (<Add><FormParams/></Add>), המדיניות לא מוסיפה פרמטרים של טופס. זה כמו להשמיט את <FormParams>.

‫<Set> משנה את Content-Type של ההודעה ל-application/x-www-form-urlencoded לפני שליחתה לנקודת הקצה של היעד.

`<Headers>` (ילד/ה של `<Set>`)

מחליף כותרות HTTP קיימות בבקשה או בתגובה, שמוגדרות על ידי הרכיב <AssignTo>.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של `<Header>` רכיבים
רכיב אב	`<Set>`
רכיבי צאצא	`<Header>`

רכיב <Headers> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
  </Set>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, הכותרת x-ratelimit-remaining מוגדרת לערך של המשתנה ratelimit.Quota-1.available.count:

<HTTPModifier name="HM-Set-RateLimit-Header">
  <Set>
    <Headers>
      <Header name="X-RateLimit-Remaining">{ratelimit.Quota-1.available.count}</Header>
    </Headers>
  </Set>
  <AssignTo>response</AssignTo>
</HTTPModifier>

אם מגדירים כותרות ריקות במדיניות (<Set><Headers/></Set>), המדיניות לא מגדירה כותרות. הפעולה הזו תהיה זהה להשמטת <Headers>.

`<Path>` (ילד/ה של `<Set>`)

`<QueryParams>` (ילד/ה של `<Set>`)

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

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מערך של `<QueryParam>` רכיבים
רכיב אב	`<Set>`
רכיבי צאצא	`<QueryParam>`

רכיב <QueryParams> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Set>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, פרמטר השאילתה address מוגדר לערך של המשתנה request.header.address:

<HTTPModifier name="HM-set-queryparams-1">
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.header.address}</QueryParam>
    </QueryParams>
  </Set>
</HTTPModifier>

אפשר להשתמש ב-<QueryParams> רק אם מתקיימים הקריטריונים הבאים:

פעלים של HTTP: ‏ GET, POST
סוג ההודעה: בקשה

אם מגדירים פרמטרים ריקים של שאילתה במדיניות (<Set><QueryParams/></Set>), המדיניות לא מגדירה פרמטרים של שאילתה. התוצאה זהה להשמטת <QueryParams>.

`<StatusCode>` (ילד/ה של `<Set>`)

הגדרת קוד הסטטוס בתשובה. לרכיב הזה אין השפעה על הבקשה.

ערך ברירת המחדל	‫'200' (כשהמאפיין `createNew` של `<AssignTo>` מוגדר כ-'true')
חובה?	אופציונלי
סוג	מחרוזת או `VARIABLE`
רכיב אב	`<Set>`
רכיבי צאצא	ללא

רכיב <StatusCode> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <StatusCode>HTTP_STATUS_CODE or {variable}</StatusCode>
  </Set>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה מוגדר קוד סטטוס פשוט:

<HTTPModifier name="HM-set-statuscode-404">
  <Set>
    <StatusCode>404<<StatusCode>
  </Set>
  <AssignTo>response</AssignTo>
</HTTPModifier>

דוגמה 2

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

<HTTPModifier name="set-statuscode-2">
  <Set>
    <StatusCode>{calloutresponse.status.code}</StatusCode>
  </Set>
  <AssignTo>response</AssignTo>
</HTTPModifier>

אפשר להשתמש ב-<StatusCode> רק אם מתקיימים הקריטריונים הבאים:

סוג ההודעה: תגובה

`<Verb>` (ילד/ה של `<Set>`)

מגדיר את פועל ה-HTTP בבקשה. לרכיב הזה אין השפעה על התשובה.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מחרוזת או `VARIABLE`
רכיב אב	`<Set>`
רכיבי צאצא	ללא

רכיב <Verb> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
  </Set>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה מוגדר פועל פשוט בבקשה:

<HTTPModifier name="HM-set-verb-1">
  <Set>
    <Verb>POST</Verb>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

דוגמה 2

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

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

<HTTPModifier name="HM-set-verb-to-dynamic-value">
  <Set>
    <Verb>{my_variable}</Verb>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

אפשר להשתמש ב-<Verb> רק אם מתקיימים הקריטריונים הבאים:

סוג ההודעה: בקשה

`<Version>` (ילד/ה של `<Set>`)

הפונקציה מגדירה את גרסת ה-HTTP בבקשה. לרכיב הזה אין השפעה על התשובה.

ערך ברירת המחדל	לא רלוונטי
חובה?	אופציונלי
סוג	מחרוזת או `VARIABLE`
רכיב אב	`<Set>`
רכיבי צאצא	ללא

רכיב <Version> משתמש בתחביר הבא:

תחביר

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</HTTPModifier>

דוגמה 1

בדוגמה הבאה, מספר הגרסה מוגדר ל-1.1:

<HTTPModifier name="HM-set-version-1">
  <Set>
    <Version>1.1</Version>
  </Set>
</HTTPModifier>

דוגמה 2

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

<HTTPModifier name="HM-set-version-2">
  <Set>
    <Version>{my_version}</Version>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

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

אפשר להשתמש ב-<Version> רק אם מתקיימים הקריטריונים הבאים:

סוג ההודעה: בקשה

יצירת הודעות בקשה בהתאמה אישית

אפשר להשתמש ב-HTTPModifier כדי ליצור הודעת בקשה בהתאמה אישית. אחרי שיוצרים בקשה בהתאמה אישית, אפשר להשתמש בה בדרכים הבאות:

גישה למשתנים שלה במדיניות אחרת
העברה לשירות חיצוני

כדי ליצור הודעת בקשה בהתאמה אישית, משתמשים ברכיב <AssignTo> במדיניות HTTPModifier. מגדירים את createNew ל-true ומציינים את השם של ההודעה החדשה בגוף הרכיב, כמו בדוגמה הבאה:

<HTTPModifier name="assignto-3">
    <AssignTo createNew="true" transport="http" type="request">MyRequestObject</AssignTo>
    ...
  </HTTPModifier>

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

בדוגמאות הבאות מוצגות הודעות בקשה מותאמות אישית:

דוגמה 1

בדוגמה הבאה נוצר אובייקט בקשה מותאם אישית באמצעות HTTPModifier:

<HTTPModifier name="HTTPModifier-3">
  <AssignTo createNew="true" type="request">MyCustomRequest</AssignTo>
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.queryparam.addy}</QueryParam>
    </QueryParams>
    <Verb>GET</Verb>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</HTTPModifier>

בדוגמה הזו:

יוצרת אובייקט חדש של הודעת בקשה בשם MyCustomRequest.
ב-MyCustomRequest, המדיניות הזו:
- מגדיר את פרמטר השאילתה address בהודעה המותאמת אישית לערך של פרמטר השאילתה addy בבקשה הנכנסת.
- מגדירה את פועל ה-HTTP ל-GET.
ההגדרה <IgnoreUnresolvedVariables> מוגדרת לערך false. כש-<IgnoreUnresolvedVariables> הוא false, אם אחת מהמשתנים שמפנים אליהם בהגדרת המדיניות לא קיימת, Apigee יעבור למצב שגיאה בתהליך העבודה של ה-API.

דוגמה 2

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

<HTTPModifier name="HTTPModifier-2">
  <AssignTo createNew="true" type="request">partner.request</AssignTo>
  <Set>
    <Verb>POST</Verb>
  </Set>
</HTTPModifier>

בדוגמה הזו נוצרת בקשה חדשה בהתאמה אישית בשם partner.request. לאחר מכן הוא מגדיר את הערך <Verb> בבקשה החדשה.

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

<HTTPModifier name="HM-Set-Header">
  <AssignTo>request</AssignTo>
  <Set>
    <Headers>
      <Header name="injected-approval-id">{MyCalloutResponse.header.approval-id}</Header>
    </Headers>
  </Set>
</HTTPModifier>

קודי שגיאה

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

שגיאות זמן ריצה

השגיאות האלה יכולות להתרחש כשהמדיניות מופעלת.

קוד תקלה	סטטוס HTTP	מטרה	תיקון
`entities.UnresolvedVariable`	`500`	משתנה של תבנית הודעה לא מוגדר או לא בתחום.
`steps.httpmodifier.InvalidStatusCode`	`500`	הערך שנקבע של קוד הסטטוס לא תקין. פרטים נוספים מופיעים במחרוזת השגיאה.

שגיאות פריסה

השגיאות האלה יכולות להתרחש כשפורסים שרת proxy שמכיל את המדיניות הזו.

שם השגיאה	מטרה	תיקון
`InvalidIndex`	אם האינדקס שצוין ברכיבי `<Remove>` של המדיניות `HTTPModifier` הוא `0` או מספר שלילי, הפריסה של API Proxy תיכשל.

משתני תקלות

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

משתנים	כאשר:	דוגמה
`httpmodifier.POLICY_NAME.failed`	‫`POLICY_NAME` הוא השם שהמשתמש נתן למדיניות שגרמה לשגיאה.	`httpmodifier.HM-SetResponse.failed = true`

דוגמה לתגובת שגיאה

הערה: כדי לטפל בשגיאות, מומלץ ללכוד את החלק errorcode בתגובת השגיאה. אל תסתמכו על הטקסט ב-faultstring, כי הוא עשוי להשתנות.

{
   "fault":{
      "detail":{
         "errorcode":"steps.httpmodifier.InvalidStatusCode"
      },
      "faultstring":"HTTPModifier[HM-SetResponse]: Invalid status code bad_request"
   }
}

דוגמה לכלל שגיאה

<FaultRule name="HTTPModifier Faults">
    <Step>
        <Name>HM-CustomNonMessageTypeErrorResponse</Name>
        <Condition>(fault.name Matches "InvalidStatusCode")</Condition>
    </Step>
    <Condition>(httpmodifier.failed = true)</Condition>
</FaultRule>

סכימות

כל סוג מדיניות מוגדר על ידי סכימת XML ‏ (.xsd). סכימות מדיניות זמינות ב-GitHub.

מדיניות HTTPModifier קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

תרחישים לדוגמה

רכיב <HTTPModifier>

תחביר

מדיניות ברירת המחדל

דוגמאות

‫1: הוספת כותרת

‫2: שינוי התשובה

‫3: הסרת פרמטר של שאילתה

הפניה לרכיב צאצא

<Add>

תחביר

דוגמה 1

דוגמה 2

דוגמה 3

<FormParams> (ילד/ה של <Add>)

תחביר

דוגמה 1

דוגמה 2

דוגמה 3

<Headers> (ילד/ה של <Add>)

תחביר

דוגמה 1

<QueryParams> (ילד/ה של <Add>)

תחביר

דוגמה 1

<AssignTo>

תחביר

דוגמה 1

דוגמה 2

דוגמה 3

<DisplayName>

תחביר

דוגמה

<IgnoreUnresolvedVariables>

תחביר

דוגמה 1

<Remove>

תחביר

דוגמה 1

דוגמה 2

<FormParams> (ילד/ה של <Remove>)

תחביר

דוגמה 1

דוגמה 2

דוגמה 3

<Headers> (ילד/ה של <Remove>)

תחביר

דוגמה 1

דוגמה 2

דוגמה 3

<QueryParams> (ילד/ה של <Remove>)

תחביר

דוגמה 1

דוגמה 2

דוגמה 3

דוגמה 4

<Set>

תחביר

דוגמה

<FormParams> (ילד/ה של <Set>)

תחביר

דוגמה 1

<Headers> (ילד/ה של <Set>)

תחביר

דוגמה 1

<Path> (ילד/ה של <Set>)

<QueryParams> (ילד/ה של <Set>)

תחביר

דוגמה 1

<StatusCode> (ילד/ה של <Set>)

תחביר

דוגמה 1

דוגמה 2

<Verb> (ילד/ה של <Set>)

תחביר

דוגמה 1

דוגמה 2

<Version> (ילד/ה של <Set>)

תחביר

מדיניות HTTPModifier

רכיב `<HTTPModifier>`

`<Add>`

`<FormParams>` (ילד/ה של `<Add>`)

`<Headers>` (ילד/ה של `<Add>`)

`<QueryParams>` (ילד/ה של `<Add>`)

`<AssignTo>`

`<DisplayName>`

`<IgnoreUnresolvedVariables>`

`<Remove>`

`<FormParams>` (ילד/ה של `<Remove>`)

`<Headers>` (ילד/ה של `<Remove>`)

`<QueryParams>` (ילד/ה של `<Remove>`)

`<Set>`

`<FormParams>` (ילד/ה של `<Set>`)

`<Headers>` (ילד/ה של `<Set>`)

`<Path>` (ילד/ה של `<Set>`)

`<QueryParams>` (ילד/ה של `<Set>`)

`<StatusCode>` (ילד/ה של `<Set>`)

`<Verb>` (ילד/ה של `<Set>`)

`<Version>` (ילד/ה של `<Set>`)