Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
El módulo apigee-access te permite acceder a las variables de caché y las variables de flujo del proxy de la API desde el código de la aplicación de Node.js. El módulo se incluye en la plataforma Apigee Edge; no
necesitas instalarlo 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 implementes código de Node.js en Edge, este módulo estará disponible para ti. Solo necesitas solicitarlo en cualquier código de Node.js que implementes. Por ejemplo:
var access=require('apigee-access');
Accede a 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 políticas y cualquier variable de flujo que crees desde tu código de Node.js. Las variables de flujo se crean y existen dentro del contexto de un proxy de API que se ejecuta en Edge. Para obtener información detallada, consulta Accede a variables de flujo en Node.js.
Cómo acceder a la caché
El módulo apigee-access te permite acceder a la caché distribuida de Apigee Edge desde el código de Node.js. Para obtener información detallada, consulta Accede a la caché en Node.js.
Usa el servicio de cuotas
El módulo apigee-access te permite acceder al servicio de cuotas de Apigee Edge desde tu código de Node.js. Para obtener información detallada, consulta Accede al servicio de cuota en Node.js.
Cómo acceder a los mapas de par clave-valor
El módulo apigee-access te permite acceder a mapas clave-valor (KVM) de Apigee Edge desde
tu código de Node.js. Para obtener información detallada, consulta Cómo acceder a mapas de pares clave-valor en Node.js.
Ejecutar en modo local frente a modo implementado
Para admitir el desarrollo y las pruebas locales, el módulo apigee-access funciona en 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 al complemento completo de variables de flujo en el modo implementado, mientras que solo un subconjunto pequeño está disponible cuando ejecutas la aplicación Node.js de manera local. Para obtener una lista de estas variables de modo local, consulta Ejecución en modo local.
Determina el modo en el que se ejecuta el módulo
Para determinar en qué modo ejecutas apigee-access:
var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());
El valor que se muestra de getMode() 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 todas las funciones son compatibles.standalone: La aplicación de Node.js se ejecuta fuera del entorno de Apigee Edge, y se aplica la funcionalidad predeterminada descrita en la parte superior del documento.
Ejecución en modo implementado
Cuando se implementan en Edge, las variables establecidas por políticas son visibles para apigee-access,
y las variables que agregan o modifican 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 admitidas en 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.
Ejecución en modo local
En “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 del código de Node.js. En esta tabla, se muestra el pequeño subconjunto de variables de flujo que están disponibles. Estas variables son compatibles con el desarrollo y las pruebas locales de aplicaciones de Node.js para Apigee Edge.
| Variable | Solo lectura | Tipo | Notas |
client.received.start.time |
Sí | Cadena | Hora en la que se recibió la solicitud |
client.received.end.time |
Sí | Cadena | Hora en la que se recibió la solicitud |
client.received.start.timestamp |
Sí | Número entero | Hora en la que se recibió la solicitud |
client.received.end.timestamp |
Sí | Número entero | Hora en la que se recibió la solicitud |
Nuevamente, 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 ver la lista completa.