Korzystanie z modułu dostępu apigee

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Moduł apigee-access umożliwia dostęp do zmiennych przepływu proxy interfejsu API i pamięci podręcznych z kodu aplikacji Node.js. Moduł jest częścią platformy Apigee Edge. Nie musisz go instalować tak jak innych modułów Node.js.

Pobieranie apigee-access

Moduł apigee-access jest zintegrowany z platformą Apigee Edge. Gdy wdrożysz kod Node.js w Edge, ten moduł będzie dostępny. Wystarczy, że go zaimportujesz w dowolnym wdrożonym kodzie Node.js. Na przykład:

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

Dostęp do zmiennych przepływu

Gdy wdrożysz aplikację Node.js w Edge, możesz uzyskać dostęp do dowolnych obsługiwanych "od razu" zmiennych przepływu, zmiennych przepływu utworzonych przez zasady i dowolnych zmiennych przepływu, które utworzysz samodzielnie w kodzie Node.js. Zmienne przepływu są tworzone i istnieją w kontekście proxy interfejsu API działającego w Edge. Szczegółowe informacje znajdziesz w artykule Dostęp do zmiennych przepływu w Node.js.

Dostęp do pamięci podręcznej

Moduł apigee-access umożliwia dostęp do rozproszonej pamięci podręcznej Apigee Edge z kodu Node.js. Szczegółowe informacje znajdziesz w artykule Dostęp do pamięci podręcznej w Node.js.

Korzystanie z usługi limitów

Moduł apigee-access umożliwia dostęp do usługi limitów Apigee Edge z kodu Node.js. Szczegółowe informacje znajdziesz w artykule Dostęp do usługi limitów w Node.js.

Dostęp do map klucz-wartość

Moduł apigee-access umożliwia dostęp do map klucz-wartość (KVM) Apigee Edge z kodu Node.js. Szczegółowe informacje znajdziesz w artykule Dostęp do map klucz-wartość w Node.js.

Uruchamianie w trybie lokalnym a trybie wdrożonym

Aby obsługiwać lokalne programowanie i testowanie, moduł apigee-access działa w trybie lokalnym bez zależności od Apigee Edge. Jednak gdy moduł jest używany z proxy interfejsu API, który jest wdrożony w Edge, funkcje „lokalne” są zastępowane przez natywne funkcje Edge. Na przykład w trybie wdrożonym dostępny jest pełny zestaw zmiennych przepływu , a w przypadku uruchamiania aplikacji Node.js lokalnie dostępny jest tylko niewielki podzbiór. Listę tych zmiennych w trybie lokalnym znajdziesz w artykule Uruchamianie w trybie lokalnym.

Określanie trybu, w którym działa moduł

Aby określić, w jakim trybie działa apigee-access:

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

Wartość zwracana przez getMode() informuje, czy aplikacja Node.js jest wdrożona w Apigee Edge, czy działa w trybie samodzielnym. Metoda zwraca jeden z tych 2 ciągów znaków wyników:

• apigee – aplikacja Node.js działa w Apigee Edge i wszystkie funkcje są obsługiwane.
• standalone – aplikacja Node.js działa poza środowiskiem Apigee Edge a domyślne funkcje opisane u góry dokumentu są aktywne.

Uruchamianie w trybie wdrożonym

Gdy wdrożysz aplikację w Edge, zmienne ustawione przez zasady są widoczne dla apigee-access, i zmienne dodane lub zmodyfikowane przez metody tego modułu są widoczne dla kolejnych zasad w przepływie serwera proxy.

Link do obsługiwanych zmiennych znajdziesz w dokumentacji zmiennych. Te zmienne, i wszystkie, które utworzysz pod własnymi nazwami, są widoczne dla apigee-access. Pamiętaj że niektóre zmienne są tylko do odczytu. Są one oznaczone w dokumentacji zmiennych.

Uruchamianie w trybie lokalnym

W „trybie lokalnym” kod Node.js jest uruchamiany poza kontekstem Apigee Edge. W tym trybie większość predefiniowanych zmiennych przepływu nie jest dostępna w kodzie Node.js code. Ta tabela zawiera niewielki podzbiór dostępnych zmiennych przepływu. Te zmienne są obsługiwane w celu umożliwienia lokalnego programowania i testowania aplikacji Node.js dla Apigee Edge.

Na platformie Apigee Edge obsługiwany jest znacznie większy zestaw predefiniowanych zmiennych. Pełną listę znajdziesz w dokumentacji zmiennych Apigee Edge .