Como anexar e configurar políticas na interface

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

Confira a documentação da Apigee Edge.

Adicionar recursos baseados em políticas a um proxy de API é um processo de duas etapas:

1. Configurar uma instância de um tipo de política.
2. Anexar a instância da política a um fluxo.

O diagrama abaixo mostra a relação entre políticas e fluxos. Como é possível ver, a política está anexada a um fluxo como uma etapa de processamento. Para configurar o comportamento desejado para a API, é preciso entender um pouco de fluxos. Esse tópico foi abordado anteriormente em Como configurar fluxos.

Um tipo de política normalmente usado é a política SpikeArrest. O SpikeArrest impede aumentos repentinos no tráfego de mensagens, o que pode ofuscar seus serviços de back-end.

Como anexar uma política a um fluxo

Observação: a Apigee está introduzindo uma nova versão do Editor de Proxy, que facilitará o gerenciamento de proxies.

As instruções nas duas primeiras guias abaixo explicam como usar o novo Editor de proxy ou o Proxy Editor clássico.

Novo Editor de proxy

Para anexar uma política a um fluxo, faça o seguinte:

1. Selecione um proxy de API e navegue até a visualização Desenvolver.
2. No painel à esquerda, clique no botão + na linha Políticas.

3. Na caixa de diálogo Criar política clique no campo Selecionar tipo de políticae role para baixo atéGerenciamento de tráfego e selecioneSpikeArrest.

4. Também é possível alterar o Nome de exibição e o Nome da política.

   

   Quando terminar, clique em Criar para criar a política.

5. Agora que você criou a política Spike Arrest, poderá anexá-la a uma etapa no PreFlow. Para fazer isso, selecione Proxy Endpoints > default > PreFlow no painel à esquerda:

   

6. Clique no botão + ao lado de PreFlow no painel Response no canto inferior direito do Editor de recursos visuais:

   

7. Na caixa de diálogo Adicionar política, selecione a política Spike Arrest.

8. Clique em Adicionar para anexar a política.

   A política Spike Arrest agora é exibida no painel Response:

   

   O código XML a seguir para o proxy é exibido no editor de texto:

   <ProxyEndpoint name="default">
     <PreFlow name="PreFlow">
       <Request/>
       <Response>
         <Step><
           <Name>SA-</Name>
         </Step>
       </Response>
     </PreFlow>
     <Flows/>
     <PostFlow name="PostFlow">
       <Request/>
       <Response/>
     </PostFlow>
     <HTTPProxyConnection>
       <BasePath>/myproxy</BasePath>
     </HTTPProxyConnection>
     <RouteRule name="default">
       <TargetEndpoint>default</TargetEndpoint>
     </RouteRule>
   </ProxyEndpoint>
     

Como remover políticas de um fluxo

Para remover uma política de um fluxo, clique no menu de três pontos ao lado do fluxo e selecione Excluir política

Editor de proxy clássico

Para anexar uma política a um fluxo, faça o seguinte:

1. Selecione um proxy de API e navegue até a visualização Desenvolver.
2. No API Proxy Editor, selecione o fluxo ao qual você quer anexar uma política no painel de navegação.
   Por exemplo, o fluxo do PreFlow é selecionado para o endpoint do proxy da API padrão na seguinte figura:
   
3. Na Visualização de "Design", clique em +Etapa associada ao fluxo de solicitação ou resposta para anexar uma política. Por exemplo:
   
   A caixa de diálogo "Adicionar etapa" é exibida com uma lista categorizada de políticas.
   
4. Role e escolha o tipo de política que você quer anexar ao fluxo selecionado.
5. Modifique os campos a seguir.

   • Nome de exibição: nome exclusivo da política. A IU vai gerar um nome padrão, mas é aconselhável criar um nome descritivo para a política. Dessa forma, outros desenvolvedores na sua organização terão facilidade para entender a intenção da política.

   • Nome: nome exclusivo da política. O nome da política corresponde ao nome de exibição, com as seguintes exceções:

     • Os espaços serão substituídos por traços.

     • Os traços consecutivos serão substituídos por um traço único.

     • Com exceção dos traços, sublinhados e espaços (que são substituídos, acima), os caracteres não alfanuméricos, como sinais de libra, sinais de porcentagem, "e" comercial etc. são removidos.

6. Clique em Add.

   A política está anexada ao fluxo selecionado.

Depois que a política for anexada, você verá a política exibida na visualização Designer para o fluxo. Neste exemplo, o PreFlow é o endpoint padrão de proxy e está na lista Políticas no painel de navegação. A visualização Código, que exibe o XML da política recém-anexada, é exibida abaixo da visualização Designer. A Apigee gera uma instância da política que contém um conjunto de valores padrão razoáveis.

Como adicionar uma política sem anexá-la a um fluxo

Para adicionar uma política sem anexá-la a um fluxo, o que é útil no caso de lidar com falhas, clique em + na barra Políticas na visualização Navegador para abrir a caixa de diálogo Adicionar política e adicionar a política, conforme descrito nas etapas de 4 a 6 da seção anterior.

Uma política que não está anexada a nenhum fluxo é sinalizada como desanexada na lista de Políticas, como aparece ao lado da política de mensagens da chave de API na figura anterior.

Depois de criar a política, é possível anexá-la a um fluxo. Para isso, arraste-a e solte-a na lista Políticas para o fluxo desejado na visualização Designer.

Como remover políticas de um fluxo

Para desanexar uma política de um fluxo, selecione o fluxo. Passe o mouse sobre o ícone da política na visualização Designer do fluxo. Clique no X, no círculo que aparece no ícone.

Como excluir uma instância de política

Para excluir uma instância de política, passe o mouse sobre a entrada da política na visualização Navegador. Clique no X no círculo que aparece à direita da entrada.

Como configurar políticas na IU

Quando a IU gera uma instância de política, ela aplica valores padrão razoáveis a configurações comuns. Talvez seja necessário alterar essas configurações para atender aos seus requisitos.

Por exemplo:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Você pode configurar uma política editando diretamente a configuração XML na visualização Código. Por exemplo, a taxa máxima de mensagens da política Spike Arrest é definida inicialmente como 30 mensagens por segundo. Para alterar essa taxa, mude o valor do elemento <Rate> no XML da política. Para mais detalhes sobre como configurar políticas, consulte a referência de políticas.

Também é possível cortar e colar políticas na visualização Código. Essa é uma ótima maneira de reutilizar políticas das amostras disponíveis no GitHub.

Quando você faz alterações em uma definição de política na visualização Código, as alterações são refletidas no Inspetor de propriedades. O inverso também é verdadeiro: faça alterações no Inspetor de propriedades, e elas aparecerão no XML na visualização Código.

Para ver a documentação específica da política de cotas usada neste tópico, consulte Política de cotas.