אתם קוראים את מאמרי העזרה של Apigee Edge.
כדאי לעיין במסמכי העזרה בנושא Apigee X. מידע

המדיניות SOAPMessageValidation מבצעת את הפעולות הבאות:
- מאמת כל הודעת XML מול סכימות ה-XSD שלה
- אימות של הודעות SOAP מול הגדרת WSDL
- קובע אם הודעות JSON ו-XML הן בפורמט תקין
למרות שהשם של המדיניות הזו בממשק המשתמש הוא 'אימות הודעות SOAP', המדיניות מאמתת יותר מסתם הודעות SOAP. בקטע הזה, המדיניות נקראת 'מדיניות אימות ההודעות'.
רכיב <MessageValidation>
הגדרת המדיניות לאימות הודעות.
ערך ברירת המחדל | מידע נוסף מופיע בכרטיסייה מדיניות ברירת המחדל שבהמשך. |
חובה? | אופציונלי |
סוג | אובייקט מורכב |
רכיב אב | לא רלוונטי |
רכיבי צאצא |
<DisplayName> <Element> <ResourceURL> <SOAPMessage> <Source> |
תחביר
התחביר של רכיב <MessageValidation>
הוא:
<MessageValidation continueOnError="[false|true]" enabled="[true|false]" name="policy_name" > <!-- All MessageValidation child elements are optional --> <DisplayName>policy_display_name</DisplayName> <Element namespace="element_namespace">element_to_validate</Element> <SOAPMessage version="[ 1.1 | 1.2 | 1.1/1.2 ]"/> <Source>message_to_validate</Source> <ResourceURL>validation_WSDL_or_XSD</ResourceURL> </MessageValidation>
מדיניות ברירת המחדל
בדוגמה הבאה מוצגות הגדרות ברירת המחדל כשמוסיפים מדיניות של אימות הודעות לזרימה בממשק המשתמש של Edge:
<MessageValidation continueOnError="false" enabled="true" name="SOAP-Message-Validation-1"> <DisplayName>SOAP Message Validation-1</DisplayName> <Properties/> <Element namespace="http://sample.com">sampleObject</Element> <SOAPMessage/> <Source>request</Source> <ResourceURL>wsdl://SOAP-Message-Validation-1.wsdl</ResourceURL> </MessageValidation>
לרכיב הזה יש את המאפיינים הבאים, המשותפים לכל כללי המדיניות:
מאפיין | ברירת מחדל | חובה? | תיאור |
---|---|---|---|
name |
לא רלוונטי | נדרש |
השם הפנימי של המדיניות. הערך של המאפיין אפשר להשתמש ברכיב |
continueOnError |
false | אופציונלי | צריך להגדיר את הערך 'False' כדי להחזיר שגיאה כשהמדיניות נכשלת. זו התנהגות צפויה ברוב סוגי המדיניות. הערך של הפרמטר הוא TRUE כדי שביצוע הפעולות יתבצע גם אחרי שמדיניות תיכשל. |
enabled |
true | אופציונלי | כדי לאכוף את המדיניות צריך להגדיר את הערך True. מגדירים את המדיניות כ-"false" כדי "להשבית" את המדיניות. המדיניות הזו לא תיאכף גם אם היא תצורף לתהליך. |
async |
false | הוצא משימוש | המאפיין הזה הוצא משימוש. |
דוגמאות
בדוגמאות הבאות מוצגות כמה מהדרכים שבהן אפשר להשתמש במדיניות של אימות הודעות:
1: אימות XSD
אפשר להשתמש במדיניות אימות ההודעות כדי לאמת את מטען הייעודי (payload) של בקשת הודעת XML מול סכימת XSD.
- יוצרים קובץ משאבים חדש מסוג XSD. For
example, "note-schema.xsd":
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="note"> <xs:complexType> <xs:sequence> <xs:element name="to" type="xs:string"/> <xs:element name="from" type="xs:string"/> <xs:element name="heading" type="xs:string"/> <xs:element name="body" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
- מוסיפים את מדיניות האימות של הודעות SOAP ל-pre-flow של נקודת הקצה של ה-proxy:
- מציינים את המיקום של קובץ משאב ה-XSD באמצעות הרכיב
<ResourceURL>
. לדוגמה:... <ResourceURL>xsd://note-schema.xsd</ResourceURL> ...
- מסירים את הרכיבים
<SOAPMessage>
ו-<Element>
מהגדרת המדיניות.
הגדרת המדיניות צריכה להיראות כך:
<MessageValidation continueOnError="false" enabled="true" name="validateXMLRequest"> <DisplayName>My XML Validator</DisplayName> <Properties/> <Source>request</Source> <ResourceURL>xsd://note-schema.xsd</ResourceURL> </MessageValidation>
- מציינים את המיקום של קובץ משאב ה-XSD באמצעות הרכיב
- שולחים בקשת
POST
לשרת ה-proxy של ה-API עם ה-XML כמטען הייעודי (payload) של ההודעה, כמו בדוגמה הבאה:curl -v -X POST -H 'Content-Type: application/xml' http://my-test.apigee.net/v1/xsd-mock -d '<note> <to>Fred Rogers</to> <from>Nick Danger</from> <heading>Greetings from my neighborhood</heading> <body>Just writing to say hello.</body> </note>'
שימו לב שהכותרת
Content-type
מוגדרת לערך application/xml.אפשר גם ליצור קובץ נתונים בשביל המטען הייעודי (payload) ולהפנות אליו באמצעות פקודה שדומה לפקודה הבאה:
curl -v -X POST -H 'Content-type: application/xml' http://my-test.apigee.net/v1/xsd-mock --data '@../examples/note-payload.xml'
אמורה להתקבל תגובה HTTP 200
. בהתאם לנקודת הקצה של היעד, יכול להיות שתקבלו פרטים נוספים על הבקשה. לדוגמה, אם משתמשים ב-http://httpbin.org/post
כנקודת הקצה של היעד ומציינים פלט -v
(מפורט), התגובה אמורה להיות דומה לזו:
< HTTP/1.1 200 OK < Date: Wed, 16 May 2018 21:24:54 GMT < Content-Type: application/xml < Content-Length: 431 < Connection: keep-alive < Server: gunicorn/19.8.1 < Access-Control-Allow-Origin: * < Access-Control-Allow-Credentials: true < Via: 1.1 vegur { "args":{}, "data":"<note><to>fred</to><from>nick</from><heading>hello</heading> <body>Just writing to say hello.</body></note>", "files":{}, "form":{}, "headers": { "Accept":"*/*", "Connection":"close", "Content-Length":"106", "Content-Type":"application/xml", "Host":"httpbin.org", "User-Agent":"curl/7.58.0" }, "json":null, "origin":"10.1.1.1, 104.154.179.1", "url":"http://httpbin.org/post" }
כדי לוודא שהאימות של XSD פועל, נסו להוסיף עוד תג לגוף הבקשה. לדוגמה:
curl -v -X POST -H 'Content-Type: application/xml' http://my-test.apigee.net/v1/xsd-mock -d '<note> <to>Fred Rogers</to> <from>Nick Danger</from> <heading>Greetings from my neighborhood</heading> <body>Just writing to say hello.</body> <badTag>Not good</badTag> </note>'
אמורה להופיע שגיאת אימות.
2: אימות SOAP
אפשר להשתמש במדיניות אימות ההודעות כדי לאמת את מטען הייעודי (payload) של בקשת הודעת SOAP מול WSDL.
- יוצרים קובץ משאבים חדש של WSDL. לדוגמה, example-wsdl.wsdl:
- מוסיפים את מדיניות האימות של הודעות SOAP ל-pre-flow של נקודת הקצה של ה-proxy:
- מגדירים את המאפיין
version
של רכיב<SOAPMessage>
לגרסה של פרוטוקול SOAP שרוצים לבצע אימות מולה. לדוגמה, "1.1":... <SOAPMessage version="1.1"/> ...
- מגדירים את הערך של רכיב
<Element>
לרכיב שרוצים לאמת:... <Element namespace="https://example.com/gateway">getID</Element> ...
<Element>
מציין את רכיב הצאצא הראשון באלמנט<Body>
במעטפת של בקשת ה-SOAP.מגדירים את מאפיין
namespace
למרחב השמות של הילד. - מציינים את המיקום של קובץ משאב ה-WSDL באמצעות הרכיב
<ResourceURL>
. לדוגמה:... <ResourceURL>wsdl://example-wsdl.wsdl</ResourceURL> ...
הגדרת המדיניות צריכה להיראות כך:
<MessageValidation continueOnError="false" enabled="true" name="validateSOAPRequest"> <DisplayName>My SOAP Validator</DisplayName> <Properties/> <Source>request</Source> <SOAPMessage version="1.1"/> <Element namespace="https://example.com/gateway">getID</Element> <ResourceURL>wsdl://example-wsdl.wsdl</ResourceURL> </MessageValidation>
- מגדירים את המאפיין
- שולחים בקשת
POST
ל-API proxy עם מעטפת SOAP בתור מטען ייעודי (payload) של ההודעה, כמו בדוגמה הבאה:curl -v -X POST -H 'Content-Type: application/xml' http://my-test.apigee.net/v1/xsd-mock -d '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prox="https://example.com/gateway" xmlns:typ="https://example.com/gateway/types"> <soapenv:Header/> <soapenv:Body> <prox:getID> <typ:MyType> <typ:ID>42</typ:ID> </typ:MyType> </prox:getID> </soapenv:Body> </soapenv:Envelope>'
שימו לב שהכותרת
Content-type
מוגדרת לערך application/xml.אפשר גם ליצור קובץ נתונים בשביל המטען הייעודי (payload) ולהפנות אליו באמצעות פקודה שדומה לפקודה הבאה:
curl -v -X POST -H 'Content-type: application/xml' http://my-test.apigee.net/v1/xsd-mock --data '@../examples/soap-payload.xml'
אמורה להתקבל תגובה HTTP 200
. בהתאם לנקודת הקצה של היעד, יכול להיות שתקבלו פרטים נוספים על הבקשה. לדוגמה, אם משתמשים ב-http://httpbin.org/post
כנקודת הקצה של היעד, התגובה צריכה להיות דומה לזו:
< HTTP/1.1 200 OK < Date: Wed, 16 May 2018 21:24:54 GMT < Content-Type: application/xml < Content-Length: 431 < Connection: keep-alive < Server: gunicorn/19.8.1 < Access-Control-Allow-Origin: * < Access-Control-Allow-Credentials: true < Via: 1.1 vegur { "args":{}, "data":"<note><to>fred</to><from>nick</from><heading>hello</heading> <body>Just writing to say hello.</body></note>", "files":{}, "form":{}, "headers": { "Accept":"*/*", "Connection":"close", "Content-Length":"106", "Content-Type":"application/xml", "Host":"httpbin.org", "User-Agent":"curl/7.58.0" }, "json":null, "origin":"10.1.1.1, 104.154.179.1", "url":"http://httpbin.org/post" }
3: XML/JSON תקין
אפשר להשתמש במדיניות של אימות הודעות כדי לוודא שמטען ייעודי (payload) של הודעת JSON או XML הוא בפורמט תקין (לא מדובר באימות). המדיניות מבטיחה שהמבנה והתוכן יעמדו בסטנדרטים המקובלים, כולל:
- יש רכיב בסיס יחיד
- התוכן לא מכיל תווים לא חוקיים
- האובייקטים והתגים מוטמעים בצורה נכונה
- תגי הפתיחה והסגירה זהים
כדי לבדוק אם מטען ייעודי (payload) בפורמט XML או JSON הוא תקין:
- מוסיפים את מדיניות האימות של הודעות SOAP ל-pre-flow של נקודת הקצה של ה-proxy.
- מסירים את הרכיבים
<ResourceURL>
,<SOAPMessage>
ו-<Element>
מהגדרת המדיניות.הגדרת המדיניות צריכה להיראות כך:
<MessageValidation async="false" continueOnError="false" enabled="true" name="validateXMLRequest"> <DisplayName>My JSON Checker</DisplayName> <Properties/> <Source>request</Source> </MessageValidation>
- שולחים בקשת
POST
ל-API proxy, כמו בדוגמה הבאה:curl -v -X POST -H 'Content-Type: application/json' http://my-test.apigee.net/v1/xsd-mock -d '{ "note": { "to": "Fred Rogers", "from": "Nick Danger", "header": "Greetings from my neighborhood", "body": "Just writing to say hello." } }'
שימו לב שהכותרת
Content-type
מוגדרת לערך application/json.כדי לבדוק אם קובץ XML בנוי בצורה תקינה, צריך להשתמש ב-XML כמטען הייעודי של ההודעה ולהגדיר את
Content-type
לערך application/xml.
אמורה להתקבל תגובה HTTP 200
. כששולחים מטען ייעודי (payload) של הודעה שלא מכיל XML או JSON בפורמט תקין, אמורה להתקבל שגיאת steps.messagevalidation.Failed
.
הפניה לרכיב צאצא
בקטע הזה מתוארים רכיבי הבן של <MessageValidation>
.
<DisplayName>
אפשר להשתמש במאפיין הזה בנוסף למאפיין name
כדי לתת למדיניות שם אחר, שנשמע טבעי יותר, ולתייג אותה בכלי לעריכת מדיניות ב-UI של ניהול ה-Proxy.
הרכיב <DisplayName>
משותף לכל סוגי המדיניות.
ערך ברירת המחדל | לא רלוונטי |
חובה? | אופציונלי. אם לא מציינים את <DisplayName> , המערכת משתמשת בערך של מאפיין name של המדיניות. |
סוג | מחרוזת |
רכיב אב | <PolicyElement> |
רכיבי צאצא | ללא |
התחביר של רכיב <DisplayName>
הוא:
תחביר
<PolicyElement> <DisplayName>policy_display_name</DisplayName> ... </PolicyElement>
דוגמה
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
לרכיב <DisplayName>
אין מאפיינים או רכיבי צאצא.
<Element>
מציין את הרכיב בהודעה שצריך לאמת. זהו הצאצא הראשון באלמנט <Body>
במעטפה של בקשת ה-SOAP.
ערך ברירת המחדל | sampleObject |
חובה? | אופציונלי |
סוג | מחרוזת |
רכיב אב |
<MessageValidation>
|
רכיבי צאצא | ללא |
התחביר של רכיב <Element>
הוא:
תחביר
... <Element namespace="element_namespace">element_to_validate</Element> ...
דוגמה 1
בדוגמה הבאה מוגדר רכיב יחיד לאימות:
... <Element namespace="https://example.com/gateway">getID</Element> ...
דוגמה 2
אפשר לציין יותר מרכיב אחד לאימות על ידי הוספת כמה רכיבי <Element>
:
... <Element namespace="https://example.com/gateway">getID</Element> <Element namespace="https://example.com/gateway">getDetails</Element> ...
לרכיב <Element>
יש את המאפיינים הבאים:
מאפיין | ברירת מחדל | חובה? | תיאור |
---|---|---|---|
namespace |
"http://sample.com" | אופציונלי | המאפיין מגדיר את מרחב השמות של הרכיב שצריך לאמת. |
<ResourceURL>
מציין את סכימת ה-XSD או את הגדרת ה-WSDL שישמשו לאימות הודעת המקור.
ערך ברירת המחדל | wsdl://display_name.wsdl |
חובה? | אופציונלי |
סוג | מחרוזת |
רכיב אב |
<MessageValidation>
|
רכיבי צאצא | ללא |
התחביר של רכיב <ResourceURL>
הוא:
תחביר
... <ResourceURL>[wsdl|xsd]://validation_WSDL_or_XSD</ResourceURL> ...
דוגמאות
לקובץ XML:
... <ResourceURL>xsd://note-schema.xsd</ResourceURL> ...
ל-WSDL:
... <ResourceURL>wsdl://example-wsdl.wsdl</ResourceURL> ...
הערך של <ResourceURL>
צריך להצביע על קובץ משאבים ב-API proxy. אי אפשר להפנות למשאבים חיצוניים באמצעות HTTP או HTTPS.
אם לא מציינים ערך ל-<ResourceURL>
, ההודעה נבדקת כדי לוודא שהיא בפורמט JSON או XML תקין, אם הכותרת Content-type
היא 'application/json' או 'application/xml', בהתאמה.
לרכיב <ResourceURL>
אין רכיבי צאצא או מאפיינים.
שימוש ב-XSD לאימות
אם מטען ה-XML שאתם מאמתים באמצעות מדיניות אימות ההודעות מפנה לסכימה אחרת, אתם צריכים להוסיף את הקידומת xsd
לקובץ ה-XSD הכלול במאפיין schemaLocation
.
סכימת הדוגמה הבאה מורכבת מכמה קובצי XSD:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:include schemaLocation="xsd://note-schema.xsd"/> <xs:include schemaLocation="xsd://letter-schema.xsd"/> <xs:include schemaLocation="xsd://user-schema.xsd"/> </xs:schema>
שימוש ב-WSDL לאימות
קובץ WSDL חייב להגדיר סכימה אחת לפחות. אם היא לא מפנה לסכימה אחת לפחות, המדיניות של אימות ההודעה נכשלת.
עומק הייבוא המקסימלי של סכימה הוא 10. אם חורגים מהמספר הזה של ייבוא מקונן, המדיניות בנושא אימות הודעות נכשלת.
<SOAPMessage>
ההגדרה הזו מגדירה את גרסת ה-SOAP שבה מדיניות אימות ההודעות מאמתת.
ערך ברירת המחדל | לא רלוונטי |
חובה? | אופציונלי |
סוג | לא רלוונטי |
רכיב אב |
<MessageValidation>
|
רכיבי צאצא | ללא |
התחביר של רכיב <SOAPMessage>
הוא:
תחביר
... <SOAPMessage version="[ 1.1 | 1.2 | 1.1/1.2 ]"/> ...
דוגמה
... <SOAPMessage version="1.1"/> ...
לרכיב <SOAPMessage>
יש את המאפיינים הבאים:
מאפיין | ברירת מחדל | חובה? | תיאור |
---|---|---|---|
version |
ללא | אופציונלי | גרסת ה-SOAP שבה המדיניות הזו משתמשת כדי לאמת הודעות SOAP.
הערכים החוקיים כוללים:
|
מידע נוסף זמין במאמר From SOAP/1.1 to SOAP Version 1.2 in 9 points (מ-SOAP/1.1 ל-SOAP גרסה 1.2 ב-9 נקודות).
<Source>
מזהה את הודעת המקור שצריך לאמת. הערך של הרכיב הזה הוא שם ההודעה שרוצים לאמת.
אם לא מגדירים את <Source>
, מדיניות ברירת המחדל היא message, שמתייחסת להודעת הבקשה המלאה (בתהליך בקשה) או להודעת התשובה (בתהליך תשובה), כולל מטען ייעודי כלשהו. אפשר גם להגדיר אותו באופן מפורש כ-"בקשה" או "תשובה" כדי להתייחס לבקשה או לתשובה.
ערך ברירת המחדל | בקשה |
חובה? | אופציונלי |
סוג | מחרוזת |
רכיב אב |
<MessageValidation>
|
רכיבי צאצא | ללא |
התחביר של רכיב <Source>
הוא:
תחביר
... <Source>message_to_validate</Source> ...
דוגמה
... <Source>request</Source> ...
בנוסף לערכים message, request ו-response, אפשר להגדיר את הערך של <Source>
לשם של כל הודעה בתהליך. עם זאת, אם תעשו את זה, תצטרכו ליצור הודעה בהתאמה אישית עם השם הזה בתהליך לפני שהמדיניות הזו תופעל. אחרת, תקבלו שגיאה.
אם אי אפשר לפתור את הערך של <Source>
בזרימת ההודעות או שהוא נפתר כסוג שאינו הודעה, מתרחש אחד מהמקרים הבאים:
- אם הערך הוא null: Edge מחזירה שגיאה מסוג
steps.messagevalidation.SourceMessageNotAvailable
. - אם מדובר בסוג שאינו הודעה: Edge יציג שגיאה מסוג
steps.messagevalidation.NonMessageVariable
.
לרכיב <Source>
אין מאפיינים או רכיבי צאצא.
קודי שגיאה
השגיאות שמוחזרות ממדיניות Edge הן בפורמט עקבי, כפי שמתואר בהפניה לקודי שגיאה.
בקטע הזה מתוארים קודי התקלות והודעות השגיאה שמוחזרים, ומשתני השגיאה שמוגדרים על ידי Edge כשהמדיניות הזו גורמת לשגיאה. חשוב לדעת אם אתם מפתחים כללים לתיקון תקלות. מידע נוסף זמין במאמר מה צריך לדעת על שגיאות מדיניות ועל טיפול בפגמים.
שגיאות בזמן ריצה
השגיאות האלה יכולות להתרחש כשהמדיניות מופעלת.
קוד שגיאה | סטטוס HTTP | סיבה | תיקון |
---|---|---|---|
steps.messagevalidation.SourceMessageNotAvailable |
500 |
השגיאה הזו מתרחשת אם משתנה שצוין ברכיב
|
build |
steps.messagevalidation.NonMessageVariable |
500 |
השגיאה הזו מתרחשת אם הרכיב משתנים של סוגי הודעות מייצגים את כל הבקשות והתגובות של HTTP. משתני הזרימה המובנים של Edge |
build |
steps.messagevalidation.Failed |
500 | השגיאה הזו מתרחשת אם המדיניות SOAPMessageValidation לא מאמתת את המטען הייעודי (payload) של הודעת הקלט מול סכימת XSD או ההגדרה של WSDL. זה יקרה גם אם בהודעת המטען הייעודי (payload) יש JSON או XML לא תקינים. | build |
שגיאות בפריסה
השגיאות האלה יכולות להתרחש כשפורסים שרת proxy שכולל את המדיניות הזו.
שם השגיאה | סיבה | תיקון |
---|---|---|
InvalidResourceType |
הרכיב <ResourceURL> במדיניות SOAPMessageValidation מוגדר לסוג משאב שלא נתמך במדיניות.
|
build |
ResourceCompileFailed |
סקריפט המשאב שמפנה לרכיב <ResourceURL> במדיניות SOAPMessageValidation
מכיל שגיאה שמונעת את ההידור שלו.
|
build |
RootElementNameUnspecified |
הרכיב <Element> במדיניות SOAPMessageValidation לא מכיל את השם של רכיב הבסיס. |
build |
InvalidRootElementName |
הרכיב <Element> במדיניות SOAPMessageValidation מכיל שם של רכיב בסיס שלא תואם לכללי ה-XML למתן שמות חוקיים לרכיבים. |
build |
סכימות
כל סוג מדיניות מוגדר על ידי סכימת XML (.xsd
). סכימות מדיניות זמינות ב-GitHub.