שימוש במודול הגישה לממשק ה-API

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X.
מידע

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

קבלת apigee-access

מודול apigee-access משולב בפלטפורמת Apigee Edge. כשפורסים קוד Node.js ב-Edge, המודול הזה זמין לכם. פשוט צריך להוסיף אותו לכל קוד Node.js שפורסים. לדוגמה:

var access=require('apigee-access');

גישה למשתני זרימה

כשפורסים אפליקציית Node.js ב-Edge, אפשר לגשת לכל משתני הזרימה הנתמכים 'מוכנים לשימוש', למשתני זרימה שנוצרו על ידי מדיניות ולכל משתני הזרימה שיוצרים בעצמכם מתוך קוד Node.js. משתני Flow נוצרים וקיימים בהקשר של proxy ל-API שפועל ב-Edge. מידע מפורט זמין במאמר בנושא גישה למשתני זרימה ב-Node.js.

גישה למטמון

מודול apigee-access מאפשר לכם לגשת למטמון המבוזר של Apigee Edge מקוד Node.js. מידע מפורט זמין במאמר בנושא גישה למטמון ב-Node.js.

שימוש בשירות המכסות

מודול apigee-access מאפשר לכם לגשת לשירות המכסות של Apigee Edge מהקוד שלכם ב-Node.js. מידע מפורט מופיע במאמר גישה לשירות המכסות ב-Node.js.

גישה למפות של צמדי מפתח/ערך

מודול apigee-access מאפשר לכם לגשת למפות מפתח-ערך (KVM) של Apigee Edge מקוד Node.js. מידע מפורט זמין במאמר בנושא גישה למיפויים של זוגות מפתח/ערך ב-Node.js.

הפעלה במצב מקומי לעומת הפעלה במצב פריסה

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

קביעת המצב שבו המודול פועל

כדי לקבוע באיזה מצב מופעלת apigee-access:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

ערך ההחזרה של getMode() מציין אם אפליקציית Node.js נפרסה ב-Apigee Edge או שהיא פועלת במצב עצמאי. הפונקציה מחזירה אחת משתי תוצאות המחרוזת הבאות:

  • apigee – אפליקציית Node.js פועלת ב-Apigee Edge וכל הפונקציונליות נתמכת.
  • standalone – אפליקציית Node.js פועלת מחוץ לסביבת Apigee Edge והפונקציונליות שמוגדרת כברירת מחדל שמתוארת בחלק העליון של המסמך נכנסת לתוקף.

הרצה במצב פריסה

כשפורסים את המודול ב-Edge, משתנים שמוגדרים על ידי מדיניות גלויים ל-apigee-access, ומשתנים שנוספו או שונו על ידי השיטות של המודול הזה גלויים למדיניות הבאה בתהליך של ה-proxy.

קישור לרשימת המשתנים הנתמכים מופיע בהפניה למשתנים. המשתנים האלה, וכל משתנה שתיצרו עם שמות משלכם, גלויים ל-apigee-access. הערה חלק מהמשתנים הם לקריאה בלבד. הם מפורטים בהפניה למשתנים.

הפעלה במצב מקומי

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

משתנה קריאה בלבד סוג הערות
client.received.start.time כן מחרוזת השעה שבה הבקשה התקבלה
client.received.end.time כן מחרוזת השעה שבה הבקשה התקבלה
client.received.start.timestamp כן מספר שלם השעה שבה הבקשה התקבלה
client.received.end.timestamp כן מספר שלם השעה שבה הבקשה התקבלה

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