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

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X.
מידע

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

קבלת גישה ל-apigee

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

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

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

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

גישה למטמון

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

איך משתמשים בשירות המכסות

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

גישה למפות של ערכי מפתחות

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

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

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

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

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

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

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

  • 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 חומר עזר – כדי לראות את הרשימה המלאה.