פיתוח של ממשקי proxy ל-API

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

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

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

מפתחים את ה-API proxies באמצעות Apigee ב-Cloud Code, כמו שמתואר בקטעים הבאים. אפשר גם לעיין במאמר בנושא ניהול תיקיות וקבצים במרחב עבודה של Apigee.

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

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

יצירת proxy ל-API

כדי ליצור proxy ל-API באמצעות Apigee ב-Cloud Code, צריך לוודא שיצרתם סביבת עבודה מקומית לפיתוח, ואז:

1. מבצעים אחת מהפעולות הבאות:

   • בסביבת העבודה, מעבירים את הסמן מעל התיקייה apiproxies ולוחצים על .

     

   • בוחרים באפשרות View > Command Palette (תצוגה > לוח הפקודות) כדי לפתוח את לוח הפקודות, ואז בוחרים באפשרות Cloud Code: Create Apigee proxy bundle (Cloud Code: יצירת חבילת proxy של Apigee).

   ייפתח האשף Create proxy.

2. בוחרים באחת מהאפשרויות הבאות:

   סוג	תיאור
   Access token-based authentication	הוספת אימות מבוסס OAuth 2.0 ל-proxy ל-API. ‫Apigee מוסיף באופן אוטומטי את כללי המדיניות הבאים ל-proxy ל-API: מכסה לניהול מכסה בשרת ה-proxy. ‫AssignMessage כדי להסיר את מפתח ה-API שסופק בקריאה ל-API כפרמטר של שאילתה, מהבקשה שמועברת לשרת העורפי. ‫OAuthV2 כשיטת האימות.
   API key-based authentication	proxy ל-API שמשתמש באימות פשוט של מפתח API. ‫Apigee מוסיף באופן אוטומטי את כללי המדיניות הבאים ל-proxy ל-API: מכסה לניהול מכסה בשרת ה-proxy. ‫VerifyAPIKey כדי לאמת מפתחות API שמוצגים על ידי אפליקציות ששולחות בקשות. ‫AssignMessage כדי להסיר את מפתח ה-API שסופק בקריאה ל-API כפרמטר של שאילתה, מהבקשה שמועברת לשרת העורפי.
   Echo request	proxy ל-API שמחזיר בקשות. אין בק-אנד של יעד או API לסוג הפרוקסי הזה ואין אימות. לא מוצגת בקשה לציין כתובת URL לשירות לקצה העורפי (Target (Existing API)), והגדרת נקודת הקצה של היעד שמוגדרת כברירת מחדל לא נכללת.
   Simple reverse proxy	proxy ל-API שמעביר בקשות ליעד בקצה העורפי. הוא לא כולל אימות, ולכן הבקשות מועברות לקצה העורפי ללא בדיקות אבטחה.
   OpenAPI 3.0 spec	יוצרים שרת proxy על ידי טעינת מפרט קיים של OpenAPI 3.0. מידע נוסף זמין באתר OpenAPI Initiative.

3. מידע על השדות, כמו נתיב הבסיס, שנדרשים ליצירת כל סוג של proxy מופיע במאמר שדות ראשיים של proxy ל-API. משיבים לכל ההנחיות ומקישים על Enter כדי לאשר ולהמשיך, או על Esc כדי לבטל את האשף.

אחרי שמשלימים את השלבים באשף, התיקייה החדשה apiproxy-name מתווספת לקטע Apigee מתחת ל-apiproxies. כל תיקיית proxy ל-API בנויה כמו שמתואר ב-API proxy configuration directory structure.

בדוגמה הבאה מוצגת הגדרת ברירת המחדל שנוצרת ל-proxy ל-API שנוצר עם סוג API key-based authentication.

תיאור של הגדרת ברירת המחדל מופיע במאמר הגדרת ברירת המחדל של proxy ל-API.

עיון בהגדרת ברירת המחדל של proxy ל-API

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

קובץ תצורה	שרת proxy הפוך פשוט	בקשת הד	אימות באמצעות אסימון גישה (OAuthV2)	אימות באמצעות מפתח API
proxies/default.xml הגדרת ברירת המחדל של נקודת קצה של שרת Proxy.
targets/default.xml הגדרת ברירת המחדל של נקודת הקצה של היעד.
impose-quota.xml מדיניות מכסות כדי להגדיר מכסה כברירת מחדל.
‫remove-header-authorization.xml AssignMessage policy כדי להסיר את הכותרת Authorization שמועברת לאימות.
remove-query-param-apikey.xml מדיניות AssignMessage להסרת פרמטר השאילתה apikey שמועבר לצורך אימות.
‫verify-api-key.xml VerifyAPIKey policy כדי לאכוף את האימות של מפתחות API.
verify-oauth-v2-access-token.xml מדיניות OAuthV2 לאימות אסימוני גישה מסוג OAuth V2.

העלאה של חבילת proxy ל-API

כדי להעלות חבילת proxy ל-API אל Apigee ב-Cloud Code:

1. מבצעים אחת מהפעולות הבאות:

   • בסביבת העבודה של Apigee, מעבירים את סמן העכבר מעל התיקייה apiproxies ולוחצים על .

   • בוחרים באפשרות View > Command Palette (תצוגה > לוח הפקודות) כדי לפתוח את לוח הפקודות, ואז בוחרים באפשרות Cloud Code: Import Apigee proxy bundle (Cloud Code: ייבוא חבילת שרת proxy של Apigee).

2. מנווטים לחבילת ה-proxy ל-API שרוצים להעלות ולוחצים על בחירה. חבילת ה-proxy ל-API צריכה להיות מובנית כמו שמתואר ב-API proxy configuration directory structure.

3. (אופציונלי) כברירת מחדל, השם של קובץ ה-ZIP בלי הסיומת משמש כשם של ה-proxy ל-API. אם השם לא ייחודי, תתבקשו להזין שם ייחודי.

התיקייה apiproxy-name שהועלתה מתווספת לקטע apiproxies בסביבת העבודה.

ניהול נקודות קצה של שרת proxy

כפי שמתואר במאמר מהו proxy ל-API?, נקודת קצה של שרת proxy (ProxyEndpoint) מגדירה את האופן שבו אפליקציות לקוח צורכות את ממשקי ה-API שלכם. מגדירים את נקודת הקצה של ה-proxy כדי להגדיר את כתובת ה-URL של שרת ה-proxy ל-API. נקודת הקצה של ה-proxy קובעת גם אם האפליקציות ניגשות ל-proxy ל-API דרך HTTP או HTTPS. אתם יכולים לצרף מדיניות לנקודת הקצה של ה-proxy כדי לאכוף אבטחה, בדיקות מכסה וסוגים אחרים של בקרת גישה והגבלת קצב.

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

יצירת נקודות קצה של שרת proxy

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

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

כדי ליצור נקודת קצה של שרת proxy באמצעות Apigee ב-Cloud Code:

1. בסביבת העבודה של Apigee, מבצעים אחת מהפעולות הבאות:

   • מעבירים את הסמן מעל אחת מהתיקיות הבאות, לוחצים על ובוחרים באפשרות יצירת נקודת קצה של שרת proxy:
     • apiproxy-name חבילת proxy
     • apiproxy-name/apiproxy
   • מציבים את הסמן מעל התיקייה apiproxy-name/apiproxy/proxies ולוחצים על .

   ייפתח האשף Create proxy endpoint (יצירת נקודת קצה של שרת proxy).

2. מזינים את הערכים להנחיות הבאות. מקישים על Enter אחרי כל פעולה כדי לאשר ולהמשיך, או על Esc כדי לבטל.

   שדה	תיאור
   Proxy endpoint name	השם שמשמש לזיהוי נקודת הקצה של ה-proxy.
   API proxy base path	חלק מכתובת ה-URL שמשמשת לשליחת בקשות ל-API. מערכת Apigee משתמשת בכתובת ה-URL כדי להתאים בקשות נכנסות ולנתב אותן ל-proxy ל-API המתאים.
   Target endpoint	בוחרים באפשרות no target או באפשרות default. מידע נוסף זמין במאמר רכיבי ההגדרה של ProxyEndpoint.

נקודת הקצה נוצרת ומוסיפים אותה לתיקייה apiproxy-name/apiproxy/proxies בקטע Apigee, והיא נפתחת בעורך. מגדירים את נקודת הקצה של ה-proxy, כמו שמתואר בקטע הבא.

הגדרת נקודות קצה של שרת Proxy

כדי להגדיר נקודות קצה של שרת proxy, אפשר לעיין בסעיפים הבאים:

• שליטה באופן ההפעלה של שרת proxy באמצעות תהליכי עבודה
• קביעת כתובת ה-URL של נקודת הקצה של ה-proxy ל-API
• הוספת תכונות באמצעות כללי מדיניות
• ניהול משאבים
• הגדרות של ProxyEndpoint
• הסבר על הגדרת תהליכים
• הפניה למאפיינים של נקודות קצה

ניהול נקודות קצה (endpoint) של היעד

כפי שמתואר במאמר מהו שרת proxy ל-API?, נקודת קצה של יעד (TargetEndpoint) מגדירה את האופן שבו שרת ה-proxy ל-API מתקשר עם שירותי הקצה העורפי. מגדירים את נקודת הקצה של היעד להעברת בקשות לשירות לקצה העורפי המתאים, ומגדירים את הגדרות האבטחה, פרוטוקול HTTP או HTTPS ופרטי חיבור אחרים. אתם יכולים לצרף מדיניות לנקודת הקצה של היעד כדי לוודא שהודעות התגובה בפורמט המתאים לאפליקציה ששלחה את הבקשה הראשונית.

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

יצירת נקודות קצה של יעד

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

יוצרים נקודות קצה לטירגוט, לפי הצורך.

הערה: ל-proxy ל-API לא צריך להיות יעד נקודת קצה. אפשר להגדיר נקודות קצה של proxy כדי לקרוא לכתובות URL ישירות. proxy ל-API ללא נקודות קצה של יעד מכיל בדרך כלל נקודת קצה של proxy שקוראת ישירות לשירות לקצה העורפי או מוגדרת לקרוא לשירות באמצעות Java או JavaScript.

כדי ליצור נקודת קצה של יעד באמצעות Apigee ב-Cloud Code:

1. בסביבת העבודה של Apigee, מבצעים אחת מהפעולות הבאות:

   • ממקמים את הסמן מעל אחת מהתיקיות הבאות, לוחצים על ובוחרים באפשרות יצירת נקודת קצה של יעד:
     • apiproxy-name חבילת proxy
     • apiproxy-name/apiproxy
   • מציבים את הסמן מעל התיקייה apiproxy-name/apiproxy/targets ולוחצים על .

   ייפתח האשף Create target endpoint.

2. מבצעים את השלבים הבאים בהתאם לסוג נקודת הקצה של היעד שרוצים ליצור:

   סוג	שלבים
   יעד חיצוני מסוג HTTP(s)	כדי להגדיר יעד חיצוני מסוג HTTP(s): בוחרים באפשרות יעד HTTP(s). מזינים את השם של נקודת הקצה של היעד בשדה Target endpoint name (שם נקודת הקצה של היעד). מזינים את כתובת ה-URL של שירות לקצה העורפי שנקודת הקצה הזו קוראת לו בשדה Backend target URL. מידע נוסף זמין במאמר איך קובעים את כתובת ה-URL של נקודת הקצה של היעד.
   שרשור שרתי Proxy	כדי להגדיר שרת proxy ל-API שנפרס באופן מקומי כיעד: בוחרים באפשרות שרשור שרתי proxy. מזינים את השם של נקודת הקצה של היעד בשדה Target endpoint name (שם נקודת הקצה של היעד). בוחרים שרת proxy ל-API. בוחרים את נקודת הסיום של ה-proxy. מידע נוסף זמין במאמר בנושא שרשור של שרתי proxy.
   יעד עם איזון עומסים	כדי להגדיר יעד מאוזן עומסים באמצעות שרתי יעד שמוגדרים בסביבה: בוחרים באפשרות יעד עם איזון עומסים. מזינים את השם של נקודת הקצה של היעד בשדה Target endpoint name (שם נקודת הקצה של היעד). מידע נוסף זמין במאמר הגדרת TargetEndpoint לאיזון עומסים בין TargetServer עם שמות.

נקודת היעד נוצרת ונוספת לתיקייה apiproxy-name/apiproxy/targets ונפתחת בעורך. מגדירים את נקודת הקצה של היעד, כמו שמתואר בקטע הבא.

הגדרת נקודות קצה לטירגוט

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

• איזון עומסים בין שרתים עורפיים
• שליטה באופן ההפעלה של שרת proxy באמצעות תהליכי עבודה
• שרשור של שרתי proxy ל-API
• קביעת כתובת ה-URL של נקודת הקצה של היעד
• הוספת תכונות באמצעות כללי מדיניות
• ניהול משאבים
• הגדרה של TargetEndpoint
• הסבר על הגדרת תהליכים
• הפניה למאפיינים של נקודות קצה