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

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

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

קבלת גישה לממשק API

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

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

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

כאשר פורסים אפליקציית Node.js ל-Edge, אפשר לגשת לכל משתני הזרימה הנתמכים, משתני זרימה המוגדרים על ידי המדיניות ומשתני זרימה שונים שאתם יוצרים בעצמכם מתוך קוד 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, הפונקציונליות 'מקומית' מוחלפת בפונקציונליות המקורית של 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.

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

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