Como anexar e configurar políticas em arquivos XML

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

É possível criar e editar políticas localmente usando seu editor de texto ou com reconhecimento de XML favorito. Este tópico usa o tipo de política de cota como um exemplo de como criar, configurar, anexar, implantar e testar políticas.

A maioria dos proxies de API impõe uma cota. As cotas fornecem controle sobre a frequência com que um app cliente pode invocar uma API em um determinado intervalo de tempo. No exemplo abaixo, uma política de cota foi configurada para limitar os apps a uma solicitação por minuto. Isso pode não ser realista, mas apresenta uma maneira simples de ver os efeitos de uma política.

Em uma configuração de proxy de API, os arquivos da política são armazenados como arquivos XML no diretório /apiproxy/policies.

Por exemplo, uma política do tipo Cota chamada Política de cotas poderia ser criada como um arquivo chamado QuotaPolicy.xml com o seguinte conteúdo:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

É possível criar um arquivo de texto manualmente ou gerar a política com base em um esquema XML. Todas as políticas têm algumas configurações específicas ao tipo de política, e algumas configurações que são genéricas em todas as políticas.

Quando você anexa políticas na IU de gerenciamento, o criador de proxy de API gera a instância de política com base no esquema XML para o tipo de política selecionado. Portanto, você pode ver os elementos na configuração da política que, por motivo de clareza, nem sempre estão incluídos na documentação.

Todas as políticas definem os seguintes atributos:

• enabled: indica se a política está ativada ou desativada. As políticas podem ser ativadas/desativadas no ambiente deexecução, alterando essa configuração. Uma política que tenha enabled definido como false não é aplicada.
• continueOnError: define se o pipeline continuará a processar a mensagem se a política falhar. Ao aplicar políticas de cota, os erros provavelmente indicam que a cota foi excedida e, portanto, esse atributo precisa ser definido como falso.
• name: o nome dado à política. Esse nome é exclusivo para essa instância da política e é usado para anexar a política ao fluxo como uma etapa de processamento.

Observação: raramente é necessário modificar as configurações padrão desses atributos da política, exceto name. Por esse motivo, e para maior clareza, eles geralmente são excluídos dos exemplos de política na documentação.

No exemplo acima, os elementos Allow, Interval e TimeUnit são específicos da política de cota. Esses elementos fornecem as configurações que os Serviços da API aplicam em nome de uma API. Outros tipos de políticas definem as próprias configurações, que podem ser vistas na Referência da política.