Como adicionar recursos usando políticas

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

Confira a documentação da Apigee Edge.

Com a Apigee, é possível programar o comportamento da API usando políticas, sem escrever nenhum código. Uma política é como um módulo que implementa uma função de gerenciamento específica e limitada. As políticas são projetadas para você adicionar tipos comuns de recursos de gerenciamento a uma API de maneira eficiente e confiável.

As políticas fornecem recursos como segurança, limitação de taxa, transformação e recursos de mediação, evitando que você precise criar e manter o código por conta própria. Você não está limitado ao conjunto de tipos de políticas fornecidos pela Apigee. Também é possível escrever scripts e códigos personalizados, como aplicativos JavaScript, que ampliam a funcionalidade do proxy de API e permitem que você inove os recursos básicos de gerenciamento compatíveis com as políticas da Apigee.

Crie e anexe políticas a proxies de API e fluxos compartilhados usando a Apigee no Cloud Code, conforme descrito nas seções a seguir. Dependendo do tipo de política, talvez seja necessário criar um recurso, conforme descrito em Como gerenciar recursos. Consulte também Como gerenciar pastas e arquivos em um espaço de trabalho da Apigee.

Como criar uma política

Para criar uma política usando a Apigee no Cloud Code:

  1. No seu espaço de trabalho da Apigee, execute uma das seguintes ações com base no local em que quer anexar a política:

    Anexar a Ação
    Proxy de API Faça uma das seguintes ações:
    • Posicione o cursor sobre uma das seguintes pastas, clique em Ícone de criação de política da Apigee e selecione Criar política:
      • Pacote de proxy apiproxy-name
      • apiproxy-name/apiproxy
    • Posicione o cursor sobre a pasta apiproxy-name/apiproxy/policies do proxy de API e clique em Criar o ícone do proxy de API.
    Fluxo compartilhado Faça uma das seguintes ações:
    • Posicione o cursor sobre uma das seguintes pastas, clique em Criar ícone de fluxo compartilhado e selecione Criar política:
      • pacote de fluxo compartilhado sharedflow-name
      • sharedflow-name/sharedflowbundle
    • Posicione o cursor sobre a pasta sharedflow-name/sharedflowbundle/policies no fluxo compartilhado e clique em Criar ícone de fluxo compartilhado.

O assistente "Criar política" é aberto.

  1. Selecione a categoria da política que você quer criar na lista. Para uma descrição das categorias de política, consulte Visão geral de referência da política.

  2. Digite um nome exclusivo para a política e pressione Enter. A política é adicionada à pasta /policies do proxy de API ou ao fluxo compartilhado na seção da Apigee e aberta no editor.

  3. Edite o arquivo, conforme necessário, e selecione Arquivo > Salvar ou ⌘S para salvar suas edições. Para mais informações sobre como configurar a política, consulte Visão geral de referência da política.

  4. Crie recursos se exigido pelo tipo de política, conforme descrito em Como gerenciar recursos.

Como anexar uma política a um fluxo

As políticas não são executadas até que sejam anexadas a um fluxo. É possível anexar uma política a um fluxo adicionando o elemento <Etapa> ao elemento de fluxo de resposta ou solicitação apropriado em uma configuração ProxyEndpoint ou TargetEndpoint, conforme descrito nos tópicos a seguir:

Por exemplo, a configuração a seguir anexa uma QuotaPolicy ao <PreFlow> do ProxyEndpoint para configurar o número de mensagens de solicitação que um proxy de API permite durante um período de tempo.

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
  </HTTPProxyConnection>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>