Antipattern: הגדרת מספר ProxyEndpoints בשרת proxy ל-API

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

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

בקצרה, ההגדרות של ProxyEndpoint מגדירות את כל מה שצריך לעשות כדי להטמיע API.

דוגמת עיצוב

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

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

השפעה

נקודות ProxyEndpoints מרובות בשרת proxy ל-API יכולות:

  • מקשה על המפתחים להבין ולתחזק את שרת ה-API של שרת ה-API.
  • ניתוח נתונים לא ברור. כברירת מחדל, נתוני הניתוח נצברים ברמת שרת ה-proxy. אי אפשר לראות פירוט של המדדים לפי נקודת קצה (endpoint) של שרת proxy, אלא אם יוצרים דוחות בהתאמה אישית.
  • מקשה על פתרון בעיות באמצעות שרתי proxy של API.

שיטה מומלצת

כשמטמיעים שרת proxy חדש ל-API או מעצבים מחדש שרת proxy קיים ל-API, כדאי ליישם את השיטות המומלצות הבאות:

  1. מטמיעים שרת proxy אחד ל-API עם נקודת ProxyEndpoint אחת.
  2. אם יש כמה ממשקי API שיש להם שרת יעד משותף ו/או שהם דורשים את אותה לוגיקה לפני ההפעלה או אחרי ההפעלה של שרת היעד, כדאי להשתמש בתהליכי עבודה משותפים כדי להטמיע לוגיקה כזו בשרתי proxy שונים של ה-API.
  3. אם יש כמה ממשקי API שחולקים נתיב בסיס משותף אבל הם שונים בסיומת, השתמשו בתהליכי עבודה מותנים ב-ProxyEndpoint יחיד.
  4. אם קיים שרת proxy ל-API עם כמה ProxyEndpoints, ואם אין בו בעיות, לא צריך לבצע כל פעולה.

שימוש ב-ProxyEndpoint אחד לכל שרת proxy של API מוביל אל:

  1. שרתי proxy פשוטים יותר וקלים יותר לתחזוקה
  2. מידע משופר ב-Analytics, כמו ביצועים של שרת proxy ויעד זמן תגובה, ידווח בנפרד במקום יתבצע סיכום של כל נקודות ה-ProxyEndpoints
  3. פתרון בעיות ופתרון בעיות במהירות

קריאה נוספת