O que é uma política?

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

O Apigee permite-lhe programar o comportamento da API sem escrever código, através de políticas. Uma política é como um módulo que implementa uma função de gestão específica e limitada. As políticas são concebidas para lhe permitir adicionar tipos comuns de capacidades de gestão a uma API de forma fácil e fiável. As políticas oferecem funcionalidades como segurança, limitação de taxa, transformação e capacidades de mediação, o que lhe permite não ter de programar nem manter esta funcionalidade por conta própria.

Não está limitado ao conjunto de tipos de políticas fornecidos pelo Apigee. Também pode escrever scripts e código personalizados (como aplicações JavaScript) que expandem a funcionalidade do proxy de API e lhe permitem inovar com base nas capacidades de gestão básicas suportadas pelas políticas do Apigee.

Este tópico fornece uma vista geral dos tipos de políticas e da respetiva utilização no Apigee. Para ver informações sobre políticas específicas, consulte a vista geral de referência das políticas.

Tipos e categorias de políticas

Tecnicamente, uma política é um ficheiro de configuração formatado em XML. A estrutura de cada política (por exemplo, os elementos de configuração obrigatórios e opcionais) é definida por um esquema XML. Se tiver experiência com ferramentas XML, vale a pena familiarizar-se com os esquemas de políticas nos exemplos da plataforma de APIs no GitHub.

As políticas do Apigee estão agrupadas nas seguintes categorias funcionais. As políticas disponíveis para cada categoria de políticas estão listadas na vista geral da referência de políticas.

Gestão de tráfego

As políticas na categoria de gestão de tráfego permitem-lhe controlar o fluxo de mensagens de pedido e resposta através de um proxy de API. Estas políticas suportam o controlo ao nível operacional e empresarial. Dão-lhe controlo sobre o débito bruto e também podem controlar o tráfego por app. Os tipos de políticas de gestão de tráfego permitem aplicar quotas e também ajudam a mitigar ataques de negação de serviço.

Segurança

As políticas na categoria de segurança suportam a autenticação, a autorização e a segurança baseada em conteúdo.

Mediação

As políticas na categoria de mediação permitem-lhe manipular ativamente as mensagens à medida que fluem através de proxies de API. Permitem-lhe transformar formatos de mensagens, de XML para JSON (e vice-versa), ou transformar um formato XML noutro formato XML. Também lhe permitem analisar mensagens, gerar novas mensagens e alterar valores em mensagens de saída. As políticas de mediação também interagem com os serviços básicos expostos pelo Apigee, o que lhe permite obter dados sobre apps, programadores, tokens de segurança e produtos API em tempo de execução.

Extensão

As políticas na categoria de extensões permitem-lhe tirar partido da extensibilidade do Apigee para implementar um comportamento personalizado na linguagem de programação da sua escolha.

Anexar políticas

Para que uma política se aplique ao seu proxy de API, tem de a anexar ao proxy num fluxo. Para mais informações, consulte os outros tópicos desta secção, incluindo Anexar e configurar políticas na IU e Anexar e configurar políticas em ficheiros XML.

Implementação de alterações às políticas

Para que as alterações às políticas entrem em vigor, tem de implementar a revisão do proxy de API num ambiente. Depois de anexar uma política ou fazer alterações a uma política existente, use a IU do Apigee ou a API Apigee para implementar as alterações.

Verificar a aplicação de políticas

Para verificar se uma política é aplicada corretamente, a API tem de ser invocada por um cliente HTTP. Para validar uma configuração Quota, defina uma quota (por exemplo, um pedido por minuto) e, em seguida, envie vários pedidos à API que excedam o limite da quota definido na política de quotas. (O caminho do URI, configurado como a definição do caminho base no ProxyEndpoint, no pedido abaixo é /weather).

http://ORG_NAME-test.apigee.net/weather/forecastrss?w=12797282

Depois de enviar mais do que um pedido num minuto, deve ver a seguinte mensagem de erro:

{
   "fault":{
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

Isto indica que a política Quota está a ser aplicada pelo Apigee.

Processamento de falhas baseado em políticas

Tenha em atenção o formato da mensagem de erro acima. Contém uma propriedade do faultstring e uma propriedade do errorcode. Em muitos casos, tem de implementar algum comportamento para lidar com estes erros. Por exemplo, pode querer emitir uma mensagem personalizada para um programador cuja app tenha excedido o limite de Quota.

Para mais informações sobre o processamento de falhas, consulte o artigo Processamento de falhas.

Práticas recomendadas: conjuntos de políticas comuns

Para cumprir os requisitos básicos de gestão, os proxies de API aplicam normalmente as seguintes políticas:

Validação básica da chave da API

1. SpikeArrest
2. XMLThreatProtection ou JSONThreatProtection
3. Validação da chave da API
4. Quota
5. ResponseCache

1. ResponseCache

Transformação básica: JSON para XML

1. SpikeArrest
2. JSONThreatProtection
3. Validação da chave da API
4. Quota
5. JSONToXML

1. XMLToJSON
2. ResponseCache