Como usar o módulo apigee-access

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

O módulo apigee-access permite acessar os caches e as variáveis do fluxo do proxy da API pela no código do aplicativo Node.js. O módulo está incluído na plataforma Apigee Edge. você não precisará instalá-lo como faria com outros módulos Node.js.

Como receber o apigee-access

O módulo apigee-access está integrado à plataforma Apigee Edge. Quando você implantar o código Node.js no Edge, esse módulo está disponível para você. Você só precisa solicitá-la no qualquer código Node.js que você implantar. Exemplo:

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

Como acessar variáveis de fluxo

Ao implantar um aplicativo Node.js no Edge, você pode acessar qualquer "out-of-the-box" variáveis de fluxo, variáveis de fluxo criadas por políticas e quaisquer variáveis de fluxo que que você mesmo cria no código Node.js. As variáveis de fluxo são criadas e existem o contexto de um proxy de API em execução no Edge. Para informações detalhadas, consulte Como acessar variáveis de fluxo em Node.js.

Como acessar o cache

O módulo apigee-access permite acessar o cache distribuído do Apigee Edge de seu código Node.js. Para informações detalhadas, 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 pelo seu Código Node.js. Para informações detalhadas, consulte Acessar o serviço de cotas em Node.js.

Acessar mapas de chave-valor

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

Como executar no modo local ou no modo implantado

Para oferecer suporte a desenvolvimento e testes locais, 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, o "local" é substituída pela funcionalidade nativa do Edge. Por exemplo, o o complemento completo das variáveis de fluxo é acessível no modo implantado, enquanto apenas um pequeno subconjunto disponíveis quando você executa o aplicativo Node.js localmente. Para uma lista dessas variáveis de modo local, consulte Como executar no modo local.

Determinar o modo em que o módulo está sendo executado

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á ou não implantado no Apigee Edge ou está em execução no modo autônomo. O método retorna uma dessas duas strings resultados:

• apigee: o aplicativo Node.js está em execução no Apigee Edge e todos suporte a esse recurso.
• standalone: o aplicativo Node.js está sendo executado fora do Apigee Edge e a funcionalidade padrão descrita no início do documento leva efeito

Como executar no modo implantado

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

Você pode encontrar o link das variáveis aceitas na Referência de variáveis. Essas variáveis, e todas as que você criar com seus próprios nomes, ficam visíveis para o apigee-access. Observação que algumas variáveis são somente leitura. Elas são identificadas Referência de variáveis.

Como executar no modo local

No "modo local", você está executando seu código Node.js fora do contexto da Apigee Edge. Em nesse modo, a maioria das variáveis de fluxo predefinidas não podem ser acessadas no Node.js o código-fonte. Esta tabela mostra o pequeno subconjunto de variáveis de fluxo disponíveis. Essas variáveis são suportados aqui para dar suporte ao desenvolvimento local e teste de aplicativos Node.js para a Apigee Edge.

Novamente, a plataforma Apigee Edge oferece suporte a um conjunto muito maior de variáveis predefinidas. Consulte as variáveis do Apigee Edge Referência para ver a lista completa.