APLICA-SE A: Todas as camadas de gerenciamento de API
Neste tutorial, você aprenderá a configurar políticas para proteger ou transformar sua API. As políticas são uma coleção de instruções que são executadas sequencialmente na solicitação ou resposta de uma API que modifica o comportamento da API.
Por exemplo, talvez você queira definir um cabeçalho de resposta personalizado. Ou proteja sua API de back-end configurando uma política de limite de taxa, para que a API não seja usada em excesso pelos desenvolvedores. Esses exemplos são uma introdução simples às políticas de gerenciamento de API. Para obter mais opções de política, consulte Políticas de gerenciamento de API.
Nota
Por padrão, o Gerenciamento de API configura uma política global forward-request . A forward-request política é necessária para que o gateway conclua uma solicitação para um serviço de back-end.
Neste tutorial, irá aprender a:
Transformar uma API para definir um cabeçalho de resposta personalizado
Proteger uma API adicionando uma política de limite de taxa (limitação)
Conclua o guia de início rápido seguinte: Criar uma instância da Gestão de API do Azure. Para este tutorial, recomendamos que você use uma das camadas clássica ou v2, por exemplo, a camada Desenvolvedor ou a camada Básica v2. A camada Consumo não suporta todas as políticas usadas neste tutorial.
Na página Serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API.
Testar a resposta original
Para ver a resposta original:
Na instância do serviço Gerenciamento de API, selecione APIs.
Selecione Swagger Petstore na sua lista de APIs.
Selecione a guia Teste , na parte superior da tela.
Selecione a operação GET Localiza animais de estimação por status e, opcionalmente, selecione um valor diferente do parâmetro de consulta de status. Selecione Enviar.
A resposta original da API deve ser semelhante à seguinte resposta:
Transformar uma API para adicionar um cabeçalho de resposta personalizado
O Gerenciamento de API inclui várias políticas de transformação que você pode usar para modificar cargas úteis de solicitação ou resposta, cabeçalhos ou códigos de status. Neste exemplo, você define um cabeçalho de resposta personalizado na resposta da API.
Definir a política de transformação
Esta seção mostra como configurar um cabeçalho de resposta personalizado usando a set-header política. Aqui você usa um editor de política baseado em formulário que simplifica a configuração da política.
Selecione Swagger Petstore>Design>Todas as operações.
Na seção Processamento de saída, selecione + Adicionar política.
Na janela Adicionar política de saída, selecione Definir cabeçalhos.
Para configurar a política Definir cabeçalhos, faça o seguinte:
Em Nome, insira Personalizado.
Em Valor, selecione + Adicionar valor. Digite "Meu valor personalizado".
Selecione Guardar.
Após a configuração, um elemento de política set-header aparece na seção Processamento de saída.
Proteger uma API ao adicionar a política de limite de taxas (limitação)
Esta seção mostra como adicionar proteção à sua API de back-end configurando limites de taxa, para que a API não seja usada em excesso pelos desenvolvedores. Este exemplo mostra como configurar a rate-limit-by-key política usando o editor de códigos. Neste exemplo, o limite é definido como três chamadas a cada 15 segundos. Após os 15 segundos, um programador pode tentar chamar a API novamente.
Nota
Esta política não é suportada na camada Consumo.
Selecione Swagger Petstore>Design>Todas as operações.
Na seção Processamento de entrada, selecione o ícone do editor de código (</>).
Posicione o cursor dentro do <inbound> elemento em uma linha em branco. Em seguida, selecione Mostrar trechos no canto superior direito da tela.
Na janela direita, em Políticas de restrição de acesso, selecione Limitar taxa de chamadas por chave.
O <rate-limit-by-key /> elemento é adicionado no cursor.
Modifique seu <rate-limit-by-key /> código no elemento para o <inbound> código a seguir. Em seguida, selecione Guardar.
O resto desta secção testa as transformações de política que definiu neste artigo.
Testar o cabeçalho de resposta personalizado
Selecione Swagger Petstore>Test.
Selecione a operação GET Localiza animais de estimação por status e, opcionalmente, selecione um valor diferente do parâmetro de consulta de status. Selecione Enviar.
Como você pode ver, o cabeçalho de resposta personalizado é adicionado:
Testar o limite de taxa (limitação)
Selecione Swagger Petstore>Test.
Selecione a operação GET Localiza animais de estimação por status . Selecione Enviar várias vezes seguidas.
Depois de enviar muitas solicitações no período configurado, você obtém a resposta 429 Solicitações Demais .
Aguarde 15 segundos ou mais e selecione Enviar novamente. Neste momento, deve obter uma resposta 200 OK.
Resumo
Neste tutorial, ficou a saber como:
Transformar uma API para definir um cabeçalho de resposta personalizado
Proteger uma API adicionando uma política de limite de taxa (limitação)
Proteja as APIs de back-end contra a exposição de informações e implemente a limitação (limitação da taxa) para evitar o esgotamento de recursos com políticas no Azure Gestão de API.