با استفاده از ماژول apigee-access

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

ماژول apigee-access به شما امکان می‌دهد از درون کد برنامه Node.js به متغیرهای جریان پروکسی API و حافظه‌های پنهان دسترسی داشته باشید. این ماژول در پلتفرم Apigee Edge گنجانده شده است؛ نیازی به نصب آن مانند سایر ماژول‌های Node.js ندارید.

دسترسی به آپیژی

ماژول apigee-access در پلتفرم Apigee Edge ادغام شده است. وقتی کد Node.js را در Edge مستقر می‌کنید، این ماژول در دسترس شما قرار می‌گیرد. کافیست آن را در هر کد Node.js که مستقر می‌کنید، require کنید. برای مثال:

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

دسترسی به متغیرهای جریان

وقتی یک برنامه Node.js را در Edge مستقر می‌کنید، می‌توانید به هر یک از متغیرهای جریان پشتیبانی‌شده "خارج از جعبه"، متغیرهای جریان ایجاد شده توسط سیاست‌ها و هر متغیر جریانی که خودتان از درون کد Node.js خود ایجاد می‌کنید، دسترسی داشته باشید. متغیرهای جریان در چارچوب یک پروکسی API که روی Edge اجرا می‌شود، ایجاد شده و وجود دارند. برای اطلاعات دقیق، به «دسترسی به متغیرهای جریان در Node.js» مراجعه کنید.

دسترسی به حافظه پنهان (cache)

ماژول apigee-access به شما امکان می‌دهد از طریق کد Node.js خود به حافظه پنهان توزیع‌شده Apigee Edge دسترسی داشته باشید. برای اطلاعات بیشتر، به بخش «دسترسی به حافظه پنهان در Node.js» مراجعه کنید.

استفاده از سرویس سهمیه‌بندی

ماژول apigee-access به شما امکان می‌دهد از طریق کد Node.js خود به سرویس سهمیه Apigee Edge دسترسی داشته باشید. برای اطلاعات بیشتر، به بخش دسترسی به سرویس سهمیه در Node.js مراجعه کنید.

دسترسی به نقشه‌های مقادیر کلیدی

ماژول apigee-access به شما امکان می‌دهد از طریق کد Node.js خود به نقشه‌های کلید-مقدار Apigee Edge (KVM) دسترسی داشته باشید. برای اطلاعات بیشتر، به بخش «دسترسی به نقشه‌های کلید-مقدار در Node.js» مراجعه کنید.

اجرا در حالت محلی در مقابل حالت مستقر

برای پشتیبانی از توسعه و آزمایش محلی، ماژول apigee-access در حالت محلی و بدون وابستگی به Apigee Edge کار می‌کند. با این حال، هنگامی که این ماژول با یک پروکسی 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 قابل مشاهده هستند و متغیرهایی که توسط متدهای این ماژول اضافه یا اصلاح می‌شوند برای سیاست‌های بعدی در جریان پروکسی قابل مشاهده هستند.

می‌توانید لینک متغیرهای پشتیبانی‌شده را در مرجع متغیرها (Variables Reference) پیدا کنید. این متغیرها، و هر متغیری که با نام خودتان ایجاد می‌کنید، برای apigee-access قابل مشاهده هستند. توجه داشته باشید که برخی از متغیرها فقط خواندنی هستند. آن‌ها در مرجع متغیرها (Variables Reference) شناسایی شده‌اند.

اجرا در حالت محلی

در «حالت محلی»، شما کد Node.js خود را خارج از چارچوب Apigee Edge اجرا می‌کنید. در این حالت، اکثر متغیرهای جریان از پیش تعریف‌شده در کد Node.js شما قابل دسترسی نیستند. این جدول زیرمجموعه کوچکی از متغیرهای جریان موجود را نشان می‌دهد. این متغیرها در اینجا پشتیبانی می‌شوند تا از توسعه و آزمایش محلی برنامه‌های Node.js برای Apigee Edge پشتیبانی شود.

باز هم، در پلتفرم Apigee Edge، مجموعه بسیار بزرگتری از متغیرهای از پیش تعریف شده پشتیبانی می‌شوند. برای مشاهده لیست کامل به مرجع متغیرهای Apigee Edge مراجعه کنید.