Korzystanie z modułu dostępu apigee

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

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

Uzyskiwanie dostępu do Apigee

Moduł apigee-access jest zintegrowany z platformą Apigee Edge. Ten moduł jest dostępny podczas wdrażania kodu Node.js w Edge. Wystarczy, że będzie on wymagany we wszystkich wdrażanych kodzie Node.js. Na przykład:

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

Uzyskiwanie dostępu do zmiennych przepływu

Po wdrożeniu aplikacji Node.js w Edge uzyskasz dostęp do dowolnych obsługiwanych „gotowych” zmiennych przepływu, zmiennych przepływu tworzonych przez zasady oraz zmiennych przepływu, które tworzysz samodzielnie w kodzie Node.js. Zmienne przepływu są tworzone i istnieją w kontekście serwera proxy interfejsu API działającego w Edge. Szczegółowe informacje znajdziesz w artykule o dostępie do zmiennych przepływu w Node.js.

Uzyskiwanie dostępu 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 o uzyskiwaniu dostępu do pamięci podręcznej w środowisku 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 o dostępie do usługi limitów w środowisku Node.js.

Dostęp do map klucz-wartość

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

Uruchamianie w trybie lokalnym a w trybie wdrożonym

Aby zapewnić obsługę lokalnego programowania i testowania, moduł apigee-access działa w trybie lokalnym bez zależności od Apigee Edge. Jeśli jednak moduł jest używany z serwerem proxy interfejsu API wdrożonym w Edge, funkcja „lokalna” jest zastępowana przez natywną funkcję brzegową. Na przykład pełne uzupełnienie zmiennych przepływu jest dostępne w trybie wdrożonym, a tylko niewielki podzbiór jest dostępny podczas lokalnego uruchamiania aplikacji Node.js. Listę tych zmiennych trybu lokalnego znajdziesz w artykule Uruchamianie w trybie lokalnym.

określenie trybu, w którym działa moduł;

Aby określić, w którym trybie działasz apigee-access:

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

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

  • apigee – aplikacja Node.js działa w Apigee Edge i obsługiwane są wszystkie funkcje.
  • standalone – aplikacja Node.js działa poza środowiskiem Apigee Edge i obowiązuje domyślna funkcja opisana u góry dokumentu.

Uruchamianie w trybie wdrożenia

Po wdrożeniu w Edge wszystkie zmienne ustawione przez zasady są widoczne dla narzędzia apigee-access, a zmienne dodane lub modyfikowane przez metody tego modułu są widoczne dla kolejnych zasad w procesie serwera proxy.

Link do obsługiwanych zmiennych znajdziesz w dokumentacji zmiennych. Te zmienne oraz wszystkie utworzone przez Ciebie we własnych nazwach są widoczne dla usługi apigee-access. Pamiętaj, że niektóre zmienne są przeznaczone tylko do odczytu. Są one wskazane w dokumentacji zmiennych.

Działanie w trybie lokalnym

W „trybie lokalnym” kod Node.js uruchamia się poza kontekstem Apigee Edge. W tym trybie większość wstępnie zdefiniowanych zmiennych przepływu nie jest dostępna w kodzie Node.js. W tej tabeli pokazujemy niewielki podzbiór dostępnych zmiennych przepływu. Te zmienne są obsługiwane w tym miejscu na potrzeby lokalnego programowania i testowania aplikacji Node.js dla Apigee Edge.

Zmienna Tylko do odczytu Typ Notes
client.received.start.time Tak Ciąg znaków Godzina otrzymania żądania.
client.received.end.time Tak Ciąg znaków Godzina otrzymania żądania.
client.received.start.timestamp Tak Liczba całkowita Godzina otrzymania żądania.
client.received.end.timestamp Tak Liczba całkowita Godzina otrzymania żądania.

Również na platformie Apigee Edge obsługiwana jest znacznie większy zestaw wstępnie zdefiniowanych zmiennych. Pełną listę znajdziesz w dokumentacji zmiennych Apigee Edge.