Как использовать модуль apigee-access

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Модуль apigee-access позволяет получать доступ к переменным потока прокси-сервера 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. Переменные потока создаются и существуют в контексте прокси-сервера API, работающего в Edge. Подробную информацию можно найти в разделе Доступ к переменным потока в Node.js.

Как получить доступ к кешу

Модуль apigee-access позволяет получить доступ к распределенному кешу Apigee Edge из кода Node.js. Подробную информацию можно найти в статье Как получить доступ к кешу в Node.js.

Как использовать сервис квот

Модуль apigee-access позволяет получить доступ к сервису квот Apigee Edge из кода Node.js. Подробную информацию можно найти в статье Как получить доступ к сервису квот в Node.js.

Как получить доступ к картам пар "ключ-значение"

Модуль apigee-access позволяет получить доступ к картам "ключ-значение" Apigee Edge из кода Node.js. Подробную информацию можно найти в статье Как получить доступ к картам пар "ключ-значение" в 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, а переменные, добавленные или измененные методами этого модуля, видны последующим правилам в потоке прокси.

Список поддерживаемых переменных можно найти в справочнике по переменным. Эти переменные, а также любые другие, которые вы создадите, будут видны apigee-access. Обратите внимание, что некоторые переменные доступны только для чтения. Они описаны в Справочнике по переменным.

Работа в локальном режиме

В локальном режиме код Node.js выполняется вне контекста Apigee Edge. В этом режиме большинство предопределенных переменных потока недоступны в коде Node.js. В таблице ниже приведены некоторые из доступных переменных потока. Эти переменные поддерживаются для локальной разработки и тестирования приложений Node.js для Apigee Edge.

На платформе Apigee Edge поддерживается гораздо большее количество предопределенных переменных. Полный список приведен в Справочнике по переменным Apigee Edge.