נקודות עיקריות בפיתוח של שרת proxy ל-API

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

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

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

ב-Apigee Edge, אפשר להטמיע שרתי proxy של API על ידי הגדרת הלוגיקה של שרת ה-proxy של ה-API כרצף של שלבים שמופעלים בתגובה לבקשה מקוד לקוח. כדי לחשוף שרת proxy של API ללקוחות, עליך להגדיר נקודות קצה שכוללות כתובת URL עם נתיבי משאבים, פועל של HTTP, דרישות גוף וכו'.

אומנם הוא נקרא proxy ל-API, אבל מבחינת קוד הלקוח זה ממשק ה-API.

במאמר הסבר על ממשקי API ושרתי proxy ל-API תוכלו לקרוא סקירה כללית על שרתי proxy של API.

מסדרים את רצף הלוגיקה של שרת ה-proxy של ה-API באמצעות תהליכי עבודה

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

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

אפשר לגשת לנתוני מצבים באמצעות משתני זרימה שנוצרים על ידי שרתי proxy של API

לשרת proxy של API יש גישה למשתנים שמייצגים מצב ביצוע. אפשר לגשת למשתנים האלה מה-XML שמגדיר את שרתי ה-proxy והמדיניות ל-API. אפשר לגשת אליהן גם כשמרחיבים את שרת proxy ל-API עם שפה פרוצדורלית, כמו Java, JavaScript או Python.

המשתנים האלה שמורים על ידי Apigee Edge. סוגים מסוימים קיימים כברירת מחדל, בדרך כלל מפני שהם משותפים לשרתי proxy של API (למשל, מפני שהם חלק מבקשת HTTP). אפשר גם ליצור משתנים משלכם כדי לעמוד בדרישה הלוגית.

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

אפשר להפעיל שרתי proxy של API באופן מותנה

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

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

ניתן להטמיע את רוב הלוגיקה בשרת proxy ל-API באמצעות כללי מדיניות

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

אפשר לקרוא מידע נוסף על מדיניות במאמר מהי מדיניות?

אפשר לכלול קבוצות של פונקציות לשימוש חוזר

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

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

ניתן לנפות באגים בשרת Proxy באמצעות כלי המעקב

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

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

אתם מטפלים בשגיאות של שרת proxy של API כתקלות

כשמגדירים handler של כשל, אפשר להתאים אישית את השגיאה שמוחזרת ללקוח API. הגורמים המטפלים בשגיאות מעניקים לך שליטה על הודעות השגיאה – בין אם מקור השגיאה הוא בקוד שלך ובין אם ברכיב שנכלל (כמו מדיניות).

מידע נוסף זמין במאמר טיפול בשגיאות.