Como usar o módulo apigee-access

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

O módulo apigee-access permite acessar variáveis de fluxo e caches de proxy de API de no código do aplicativo Node.js. O módulo está incluído na plataforma Apigee Edge. Não é necessário instalá-lo como faria com outros módulos do Node.js.

Como conseguir o apigee-access

O módulo apigee-access está integrado à plataforma Apigee Edge. Quando você implanta o código do Node.js no Edge, esse módulo fica disponível. Basta exigí-lo em qualquer código do Node.js que você implanta. Exemplo:

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

Como acessar variáveis de fluxo

Ao implantar um aplicativo Node.js no Edge, é possível acessar qualquer uma das variáveis de fluxo "prontas para uso" com suporte , variáveis de fluxo criadas por políticas e qualquer variável de fluxo criada no código do Node.js. As variáveis de fluxo são criadas e existem no contexto de um proxy de API em execução no Edge. Para mais informações, consulte Como acessar variáveis de fluxo no Node.js.

Como acessar o cache

O módulo apigee-access permite acessar o cache distribuído do Apigee Edge no código do Node.js. Para mais informações, consulte Como acessar o cache no Node.js.

Como usar o serviço de cota

O módulo apigee-access permite acessar o serviço de cota do Apigee Edge no código do Node.js. Para mais informações, consulte Como acessar o serviço de cota no Node.js.

Como acessar mapas de chave-valor

O módulo apigee-access permite acessar mapas de chave-valor (KVMs) do Apigee Edge no código do Node.js. Para mais informações, consulte Como acessar mapas de chave-valor no Node.js.

Como executar no modo local x modo implantado

Para oferecer suporte ao desenvolvimento e teste local, o módulo apigee-access funciona em um modo local sem dependências no Apigee Edge. No entanto, quando o módulo é usado com um proxy de API que é implantado no Edge, a funcionalidade "local" é substituída pela funcionalidade nativa do Edge. Por exemplo, o complemento completo de variáveis de fluxo é acessível no modo implantado, enquanto apenas um pequeno subconjunto está disponível quando você executa o aplicativo Node.js localmente. Para uma lista dessas variáveis de modo local, consulte Como executar no modo local.

Como determinar o modo em que o módulo está em execução

Para determinar em qual modo você está executando o apigee-access:

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

O valor de retorno de getMode() informa se o aplicativo Node.js está implantado no Apigee Edge ou em execução no modo independente. O método retorna um destes dois resultados de string results:

• apigee - O aplicativo Node.js está em execução no Apigee Edge e todas as funcionalidades são compatíveis.
• standalone - O aplicativo Node.js está em execução fora do ambiente do Apigee Edge e a funcionalidade padrão descrita na parte de cima do documento entra em vigor.

Como executar no modo implantado

Quando implantadas no Edge, as variáveis definidas por políticas ficam visíveis para apigee-access, e as variáveis adicionadas ou modificadas pelos métodos desse módulo ficam visíveis para políticas subsequentes em o fluxo de proxy.

É possível encontrar o link das variáveis com suporte na Referência de variáveis. Essas variáveis, e qualquer outra que você criar com seus próprios nomes, ficam visíveis para apigee-access. Observe que algumas variáveis são somente leitura. Elas são identificadas na Referência de variáveis.

Como executar no modo local

No "modo local", você está executando o código do Node.js fora do contexto do Apigee Edge. Nesse modo, a maioria das variáveis de fluxo predefinidas não está acessível no código do Node.js. Esta tabela mostra o pequeno subconjunto de variáveis de fluxo disponíveis. Essas variáveis são compatíveis aqui para oferecer suporte ao desenvolvimento e teste local de aplicativos Node.js para o Apigee Edge.

Na plataforma Apigee Edge, um conjunto muito maior de variáveis predefinidas é compatível. Consulte a Referência de variáveis do Apigee Edge para conferir a lista completa.