Usa el módulo apigee-access

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X.
info

El módulo apigee-access te permite acceder a las variables de flujo y las memorias caché del proxy de API desde el código de la aplicación Node.js. El módulo se incluye con la plataforma Apigee Edge; no es necesario que lo instales como lo harías con otros módulos de Node.js.

Obtén apigee-access

El módulo apigee-access está integrado en la plataforma Apigee Edge. Cuando implementas código de Node.js en Edge, este módulo está disponible para ti. Solo debes requerirlo en cualquier código de Node.js que implementes. Por ejemplo:

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

Accede a las variables de flujo

Cuando implementas una aplicación de Node.js en Edge, puedes acceder a cualquiera de las variables de flujo "listas para usar" compatibles , las variables de flujo creadas por las políticas y cualquier variable de flujo que crees tú mismo desde tu código de Node.js. Las variables de flujo se crean y existen en el contexto de un proxy de API que se ejecuta en Edge. Para obtener información detallada, consulta Accede a las variables de flujo en Node.js.

Accede a la caché

El módulo apigee-access te permite acceder a la caché distribuida de Apigee Edge desde tu código de Node.js. Para obtener información detallada, consulta Accede a la caché en Node.js.

Usa el servicio de cuota

El módulo apigee-access te permite acceder al servicio de cuota de Apigee Edge desde tu código de Node.js. Para obtener información detallada, consulta Accede al servicio de cuota en Node.js.

Accede a los mapas de clave-valor

El módulo apigee-access te permite acceder a los mapas de clave-valor (KVM) de Apigee Edge desde tu código de Node.js. Para obtener información detallada, consulta Accede a los mapas de clave-valor en Node.js.

Ejecuta en modo local en comparación con el modo implementado

Para admitir el desarrollo y las pruebas locales, el módulo apigee-access funciona en un modo local sin dependencias en Apigee Edge; sin embargo, cuando el módulo se usa con un proxy de API que se implementa en Edge, la funcionalidad "local" se reemplaza por la funcionalidad nativa de Edge. Por ejemplo, se puede acceder a la lista completa de variables de flujo en el modo implementado, mientras que solo un pequeño subconjunto está disponible cuando ejecutas la aplicación de Node.js de forma local. Para obtener una lista de estas variables de modo local, consulta Ejecuta en modo local.

Determina el modo en el que se ejecuta el módulo

Para determinar en qué modo ejecutas apigee-access, haz lo siguiente:

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

El valor de retorno de getMode() te indica si la aplicación de Node.js se implementa en Apigee Edge o se ejecuta en modo independiente. El método muestra uno de estos dos resultados de cadena:

  • apigee - La aplicación de Node.js se ejecuta en Apigee Edge y se admite toda la funcionalidad.
  • standalone - `standalone`: La aplicación de Node.js se ejecuta fuera del entorno de Apigee Edge y la funcionalidad predeterminada que se describe en la parte superior del documento entra en vigencia.

Ejecuta en modo implementado

Cuando se implementan en Edge, las variables establecidas por las políticas son visibles para apigee-access, y las variables agregadas o modificadas por los métodos de este módulo son visibles para las políticas posteriores en el flujo del proxy.

Puedes encontrar el vínculo de las variables compatibles en la Referencia de variables. Estas variables, y las que crees con tus propios nombres, son visibles para apigee-access. Ten en cuenta que algunas variables son de solo lectura. Se identifican en la Referencia de variables.

Ejecuta en modo local

En el "modo local", ejecutas tu código de Node.js fuera del contexto de Apigee Edge. En este modo, no se puede acceder a la mayoría de las variables de flujo predefinidas dentro de tu código de Node.js code. En esta tabla, se muestra el pequeño subconjunto de variables de flujo que están disponibles. Estas variables se admiten aquí para admitir el desarrollo y las pruebas locales de aplicaciones de Node.js para Apigee Edge.

Variable Solo lectura Tipo Notas
client.received.start.time String Hora en la que se recibió la solicitud
client.received.end.time String Hora en la que se recibió la solicitud
client.received.start.timestamp Número entero Hora en la que se recibió la solicitud
client.received.end.timestamp Número entero Hora en la que se recibió la solicitud

Una vez más, en la plataforma Apigee Edge, se admite un conjunto mucho más grande de variables predefinidas. Consulta la Referencia de variables de Apigee Edge para obtener la lista completa.