אתם קוראים את מסמכי התיעוד של Apigee Edge.
למעבר אל
מסמכי התיעוד של Apigee X info
כדי לנהל מוצרי API באמצעות ממשק המשתמש לניהול של Apigee Edge, צריך לפעול לפי ההוראות בקטע הזה. כדי לנהל מוצר API באמצעות ה-API, קראו את המאמר שימוש ב-Edge management API לפרסום ממשקי API.
בסרטון הבא מוסבר איך ליצור מוצר API.
לסקירה כללית על מוצרי API, קראו את המאמר מהו מוצר API?.
עיון בדף מוצרי ה-API
נכנסים לדף מוצרי ה-API, כמו שמתואר בהמשך.
Edge
כדי לגשת לדף מוצרי ה-API באמצעות ממשק המשתמש של Edge:
- נכנסים לכתובת https://apigee.com/edge.
- לוחצים על Publish > API Products.
הדף API Products מוצג.

כפי שמוצג בתמונה הקודמת, בדף מוצרי ה-API אפשר לבצע את המשימות הבאות, שמתוארות בהמשך הקטע הזה:
- הוספת מוצר API
- עריכה ומחיקה של מוצר API
- חיפוש ברשימת מוצרי ה-API
ממשק משתמש חדש של Edge (ענן פרטי)
כדי לגשת לדף מוצרי ה-API באמצעות ממשק המשתמש החדש של Edge:
- נכנסים לממשק המשתמש של New Edge בכתובת
http://host:3001/edge, כאשר host היא כתובת ה-IP או שם ה-DNS של המארח שמפעיל את ממשק המשתמש של New Edge. - לוחצים על Publish > API Products.
הדף API Products מוצג.

כפי שמוצג בתמונה הקודמת, בדף מוצרי ה-API אפשר לבצע את המשימות הבאות, שמתוארות בהמשך הקטע הזה:
- הוספת מוצר API
- עריכה ומחיקה של מוצר API
- חיפוש ברשימת מוצרי ה-API
הוספת מוצר API
מוסיפים מוצר API באמצעות ממשק המשתמש, כמו שמתואר בהמשך. כדי להשתמש ב-Edge API, קראו את המאמר הגדרת מוצרי API באמצעות ה-API.
כדי להוסיף מוצר API באמצעות ממשק המשתמש של Edge:
- נכנסים לדף מוצרי ה-API, כמו שמתואר למעלה.
- לוחצים על +API Product.
- מזינים את פרטי המוצר של מוצר ה-API.
שדה תיאור שם השם הפנימי של מוצר ה-API. אי אפשר לערוך את השם אחרי שיוצרים את מוצר ה-API. אל תציינו תווים מיוחדים בשם.
השם המוצג השם המוצג של מוצר ה-API. השם המוצג מופיע בממשק המשתמש ואפשר לערוך אותו בכל שלב. אם לא מציינים ערך, המערכת משתמשת בערך של השם. השדה הזה מתמלא באופן אוטומטי באמצעות הערך של השם. אתם יכולים לערוך או למחוק את התוכן שלו. השם המוצג יכול לכלול תווים מיוחדים. תיאור תיאור של מוצר ה-API. סביבה הסביבות שמוצר ה-API יאפשר גישה אליהן. לדוגמה, testאוprod.גישה רמת הגישה. פרטים נוספים זמינים בקטע רמת גישה. אישור אוטומטי של בקשות גישה הפעלת אישור אוטומטי של בקשות מפתח למוצר ה-API הזה מכל אפליקציה. כדי לדרוש אישור ידני של מפתחות, צריך להשבית את האפשרות הזו. אפשר לקרוא מידע נוסף במאמרים רישום אפליקציות וניהול מפתחות API (ממשק משתמש) ומפתחות לאפליקציות למפתחים (API). מכסה מגבלת המכסה שרוצים להפנות אליה ממדיניות המכסות. הזנת ערך מכסה לא אוכפת באופן אוטומטי הגבלות על מספר הקריאות שאפשר לבצע דרך המוצר. שרתי proxy ל-API שהמוצר מפנה אליהם חייבים לכלול את מדיניות המכסות כדי לאכוף את המכסה. מידע נוסף זמין במאמר מכסות. היקפי ההרשאות המותרים של OAuth אם אתם משתמשים ב-OAuth עם מוצר ה-API, היקפי ההרשאות המותרים של OAuth שאתם רוצים שמוצר ה-API יאפשר (כמו Read או היקפי הרשאות אחרים שאפליקציות ישלחו עם הקריאות שלהן ל-API). כדי לציין כמה היקפים, צריך להזין רשימה מופרדת בפסיקים. מידע נוסף על היקפי ההרשאות של OAuth מוסיפים את משאבי ה-API שזמינים במוצר ה-API, כולל שרתי ה-proxy ל-API ונתיבי המשאבים.
לדוגמה, אם מוסיפים למוצר proxy ל-API של "מוזיקה" עם נתיב בסיס של
/music, מוצר ה-API מאפשר קריאות ל-/music. עם זאת, אם רוצים שמוצר ה-API יאפשר גישה רק לנתיב המשאבvenues, שה-URI שלו הוא/music/venues, צריך להוסיף את נתיב המשאב/venuesלמוצר. במקרה כזה, אפשר להתקשר אל/music/venues?name=paramount, אבל השיחות אל/music/artists?name=Jack%Johnsonייחסמו.מגדירים נתיב ספציפי למשאב או מגדירים את נתיב הבסיס ואת כל נתיבי המשנה האפשריים על ידי ציון נתיב המשאב בתור
/. נתיב המשאב יכול לכלול את התווים הכלליים לחיפוש/**ו-/*. התו הכללי לחיפוש של כוכבית כפולה מציין שכל נתיבי המשנה של נתיב הבסיס נתמכים (אבל לא נתיב הבסיס). כוכבית אחת מציינת שרק מזהי URI ברמה אחת מתחת לנתיב הבסיס נתמכים. אפשר לעיין בקטע הגדרת ההתנהגות של נתיב המשאב של '/', '/*' ו-'/**', כפי שמתואר בהמשך הקטע הזה.כדי להוסיף משאבי API:
- בקטע "משאבי API", לוחצים על הוספת שרת proxy או על הוספת נתיב.
- בוחרים אם להוסיף שרת proxy ל-API, נתיב או גם שרת proxy ל-API וגם נתיב.

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

- לוחצים על הוספה או על הוספה והתחלת עוד אחת (כדי לציין משאבי API נוספים).
- (אופציונלי) משתמשים בקטע Apigee remote service targets כדי לקשר את המוצר ליעד אחד או יותר של שירות מרוחק. אם אתם לא משתמשים במתאם Apigee Envoy, אתם יכולים להתעלם מההגדרה הזו. מידע נוסף זמין במדריך התפעול של מתאם Apigee Envoy.
(אופציונלי) בקטע מאפיינים מותאמים אישית אפשר להוסיף עד 18 מאפיינים מותאמים אישית למוצר API.
מאפיינים מותאמים אישית הם צמדי מפתח/ערך שאפשר להשתמש בהם בדרכים רבות, כולל עזרה בניהול ההפעלה של שרת proxy ל-API. לדוגמה, אפשר ליצור מאפיין מותאם אישית בשם
deprecatedעם הערך true או false. בתהליך של ה-proxy ל-API, אפשר לבדוק את הערך של המאפייןdeprecatedשל מוצר ה-API (לדוגמה, באמצעות המשתנהverifyapikey.{policy_name}.apiproduct.deprecatedשזמין באופן אוטומטי אחרי שיוצרים את המאפיין המותאם אישית). אם הערך שלו הוא True (הוצא משימוש), אפשר להציג שגיאה באמצעות המדיניות Raise Fault.- לוחצים על שמירה.
הגדרת ההתנהגות של נתיב המשאב '/', '/*' ו-'/**'
בטבלה הבאה מתוארת התנהגות ברירת המחדל של מוצר API בנתיבי משאבים שונים. בדוגמה הזו, נתיב הבסיס של ה-proxy ל-API הוא /v1/weatherapikey. הנתיב למשאב של מוצר ה-API חל על הסיומת של נתיב כתובת ה-URL אחרי נתיב הבסיס.
| URI של בקשה | מותר לשימוש ב-/ | מותר ל- /* | מותר ל- /** | מותר עבור /*/2/** | מותר ל- /*/2/* |
|---|---|---|---|---|---|
|
/v1/weatherapikey |
Y |
לא |
לא |
לא |
לא |
|
/v1/weatherapikey/ |
Y |
לא |
לא |
לא |
לא |
|
/v1/weatherapikey/1 |
Y |
כן |
כן |
לא |
לא |
|
/v1/weatherapikey/1/ |
Y |
כן |
כן |
לא |
לא |
|
/v1/weatherapikey/1/2 |
Y |
לא |
כן |
לא |
לא |
|
/v1/weatherapikey/1/2/ |
Y |
לא |
כן |
כן |
לא |
|
/v1/weatherapikey/1/2/3/ |
Y |
לא |
כן |
כן |
Y |
|
/v1/weatherapikey/1/a/2/3/ |
Y |
לא |
כן |
לא |
לא |
כברירת מחדל, נתיב משאב של / במוצר API תומך בנתיב הבסיס ובכל נתיבי המשנה. לדוגמה, אם נתיב הבסיס של שרת ה-proxy ל-API הוא /v1/weatherapikey, מוצר ה-API תומך בבקשות ל-/v1/weatherapikey ולכל נתיבי המשנה, כמו /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA וכו'.
אתם יכולים לשנות את ברירת המחדל הזו כך שנתיב המשאב / יתאים רק לנתיב הבסיס של ה-proxy ל-API, כלומר מוצר ה-API לא יאפשר גישה ל-URI שיש בו משהו אחרי /. אם תבצעו את השינוי הזה, בטבלה שלמעלה רק שתי השורות הראשונות בקטע Allowed for / יכילו את האות Y.
כדי לשנות את ברירת המחדל, מנהל המערכת צריך להגדיר את הערך של המאפיין features.isSingleForwardSlashBlockingEnabled בארגון ל-true. לקוחות Cloud יכולים לשלוח את הבקשה הזו לתמיכה של Apigee Edge.
עריכת מוצר API
כדי לערוך מוצר API:
- נכנסים לדף מוצרי ה-API, כמו שמתואר למעלה.
- לוחצים על השורה של מוצר ה-API שרוצים לערוך.
- לוחצים על Edit בדף המוצר של ה-API.
- עורכים את השדות לפי הצורך.
אתם יכולים למחוק משאבים שהוספתם למוצר API. כדאי לעשות את זה אם יש תקלה במשאב או אם הוא דורש פיתוח נוסף. אחרי המחיקה, המשאב הזה כבר לא יהיה חלק ממוצר ה-API. אפליקציות שמשתמשות במוצר ה-API לא יוכלו יותר לגשת למשאב שנמחק. משאבים שנמחקו מוסרים מהמוצר אבל לא נמחקים מהמערכת, כך שמוצרים אחרים עדיין יכולים להשתמש בהם.
- לוחצים על שמירה.
ב-Apigee Edge for Public Cloud, הישויות הבאות נשמרות במטמון של Edge למשך 180 שניות לפחות אחרי הגישה אליהן.
- טוקני גישה מסוג OAuth. כלומר, יכול להיות שאסימון שבוטל עדיין יפעל במשך עד שלוש דקות, עד שתוקף המטמון שלו יפוג.
- ישויות של Key Management Service (KMS) (אפליקציות, מפתחים, מוצרי API).
- מאפיינים מותאמים אישית בטוקנים של OAuth ובישויות KMS.
מחיקת מוצר API
כדי למחוק מוצר API, צריך קודם לבטל את הרישום או השיוך של כל אפליקציות המפתחים שמשויכות למוצר. כדי לעשות את זה, אתם יכולים למחוק את האפליקציות או לבטל את מפתחות ה-API של האפליקציות.
כדי למחוק מוצר API:
- נכנסים לדף מוצרי ה-API, כמו שמתואר למעלה.
- מציבים את הסמן מעל מוצר ה-API ברשימה.
- לוחצים על
. - לוחצים על מחיקה כדי לאשר את הפעולה.