תבניות של ספר בישול לשרת proxy ל-API

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

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

תבנית הלקוח של JavaScript ל-HTTP

דפוס הלקוח של JavaScript ל-HTTP הוא אחד מכמה דפוסים שבהם אפשר להשתמש כדי ליצור מאש-אפים בצד השרת באמצעות Apigee Edge. מודל האובייקטים של JavaScript ב-Apigee מאפשר לחבר קוד JavaScript ישירות לתהליך של שרת proxy ל-API. אובייקט httpClient של מודל האובייקט מאפשר לבצע קריאות לשירותי הקצה העורפי ולאחזר תוצאות באמצעות JavaScript.

דפוס המדיניות

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

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

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

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

  • AssignMessage: יצירת הודעת בקשה, אכלוס של כותרות HTTP ופרמטרים של שאילתה, הגדרת פעולת ה-HTTP.
  • ServiceCallout: הפונקציה מפנה להודעה שנוצרה על ידי המדיניות AssignMessage, מגדירה כתובת URL של יעד לקריאה החיצונית ומגדירה שם לאובייקט התגובה שהשירות היעד מחזיר.
  • ExtractVariables: בדרך כלל מגדיר ביטוי JSONPath או XPath שמנתח את ההודעה שנוצרה על ידי מדיניות ServiceCallout הקודמת. לאחר מכן המדיניות מגדירה משתנים שמכילים את הערכים שנותחו מהתגובה של ServiceCallout.

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