Exemplos de políticas de Gestão de API
As políticas são uma funcionalidade poderosa do sistema que permite ao publicador alterar o comportamento da API através da configuração. As políticas são uma coleção de instruções que são executadas sequencialmente no pedido ou na resposta de uma API. A tabela seguinte inclui ligações para exemplos e fornece uma breve descrição de cada exemplo.
| Políticas de entrada | Descrição |
|---|---|
| Adicionar um cabeçalho Reencaminhado para permitir à API de back-end construir URLs corretos | Demonstra como adicionar um cabeçalho Reencaminhado no pedido de entrada para permitir à API de back-end construir URLs corretos. |
| Adicionar um cabeçalho com um ID de correlação | Demonstra como adicionar um cabeçalho com um ID de correlação ao pedido de entrada. |
| Adicionar capacidades para um serviço de back-end e colocar a resposta em cache | Mostra como adicionar capacidades a um serviço de back-end. Por exemplo, aceitar o nome de um local em vez de latitude e longitude numa API de previsão meteorológica. |
| Autorizar o acesso com base em afirmações JWT | Mostra como autorizar o acesso a métodos HTTP específicos numa API baseada em afirmações JWT. |
| Autorizar pedidos com um autorizador externo | Mostra como utilizar um autorizador externo para proteger o acesso à API. |
| Autorizar o acesso com o token de OAuth do Google | Mostra como autorizar o acesso aos pontos finais ao utilizar o Google como um fornecedor de tokens de OAuth. |
| Filtrar Endereços IP ao utilizar um Gateway de Aplicação | Mostra como filtrar IPs em políticas quando a instância da Gestão de API é acedida através de um Gateway de Aplicação |
| Gerar a Assinatura de Acesso Partilhado e reencaminhar o pedido para o armazenamento do Azure | Mostra como gerar a Assinatura de Acesso Partilhado através de expressões e reencaminhar o pedido para o armazenamento do Azure com a política rewrite-uri. |
| Obter o token de acesso de OAuth2 do AAD e reencaminhá-lo para o back-end | Fornece um exemplo de como utilizar o OAuth2 para autorização entre o gateway e um back-end. Mostra como obter um token de acesso do AAD e reencaminhá-lo para o back-end. |
| Obter o token X-CSRF do gateway SAP através da política de envio de pedidos | Mostra como implementar o padrão X-CSRF utilizado por muitas APIs. Este exemplo é específico do Gateway SAP. |
| Encaminhar o pedido com base no tamanho do respetivo corpo | Demonstra como encaminhar pedidos com base no tamanho dos respetivos corpos. |
| Enviar informações de contexto do pedido para o serviço de back-end | Mostra como enviar algumas informações de contexto para o serviço de back-end para registo ou processamento. |
| Definir a duração da cache de resposta | Demonstra como definir a duração da cache de resposta através do valor maxAge no cabeçalho Cache-Control enviado pelo back-end. |
| Políticas de saída | Descrição |
| Filtrar conteúdo de resposta | Demonstra como filtrar elementos de dados do payload de resposta com base no produto associado ao pedido. |
| Políticas de erro | Descrição |
| Registar erros no Stackify | Mostra como adicionar uma política de registo de erros para enviar erros para o Stackify para registo. |