Partilhar via

Depurar políticas de Gerenciamento de API do Azure no Visual Studio Code

  • Artigo

APLICA-SE A: Developer

As políticas no Gerenciamento de API do Azure fornecem recursos poderosos que ajudam os editores de API a lidar com preocupações transversais, como autenticação, autorização, limitação, cache e transformaçã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.

Este artigo descreve como depurar políticas de Gestão de API com a Extensão da Gestão de API do Azure para o Visual Studio Code.

Pré-requisitos

Restrições e limitações

  • Esse recurso usa a assinatura de acesso total interna (nível de serviço) (nome para exibição "Assinatura de acesso total integrada") para depuração.

Importante

  • O Gerenciamento de API não suporta mais assinaturas para rastreamento ou o cabeçalho Ocp-Apim-Trace .
  • Para melhorar a segurança da API, o rastreamento agora pode ser habilitado no nível de uma API individual, obtendo um token por tempo limitado usando a API REST de Gerenciamento de API e passando o token em uma solicitação para o gateway. Para obter detalhes, consulte Habilitar o rastreamento de uma API.
  • Tenha cuidado ao ativar o rastreamento, pois ele pode expor informações confidenciais nos dados de rastreamento. Certifique-se de que tem em vigor as medidas de segurança adequadas para proteger os dados de rastreio.

Iniciar uma sessão de depuração

  1. Abra o Visual Studio Code.
  2. Navegue até a extensão Gerenciamento de API em Extensões do Azure
  3. Encontre a instância de Gerenciamento de API a ser depurada
  4. Encontre a API e a operação para depurar
  5. Clique com o botão direito do mouse na operação e selecione Iniciar depuração de política

Neste ponto, a extensão tentará iniciar e estabelecer uma sessão de depuração com o gateway de Gerenciamento de API.

Iniciar depuração

Enviar um pedido de teste

Quando a sessão de depuração é estabelecida, a extensão abrirá um novo editor que nos permite criar e enviar uma solicitação HTTP de teste para esta operação aproveitando a extensão do Cliente REST.

Você notará que o cabeçalho Ocp-Apim-Debug já foi adicionado à solicitação. Esse cabeçalho é necessário e o valor deve ser definido como a chave de assinatura de nível de serviço e acesso total para acionar a funcionalidade de depuração no gateway de Gerenciamento de API.

Modifique a solicitação HTTP no editor de acordo com seu cenário de teste. Em seguida, clique em enviar solicitação para enviar a solicitação de teste para o gateway de Gerenciamento de API.

Enviar um pedido de teste

Políticas de depuração

Depois que a solicitação HTTP de teste for enviada, a extensão abrirá a janela de depuração mostrando as políticas efetivas dessa operação e parará na primeira política efetiva.

políticas de depuração

Para seguir o pipeline de políticas, você pode passar uma única etapa por políticas individuais ou definir um ponto de interrupção em uma política e ir diretamente para essa política.

No painel Variáveis, você pode inspecionar valores de variáveis criadas pelo sistema e pelo usuário. No painel Pontos de interrupção, você pode ver a lista de todos os pontos de interrupção que foram definidos. No painel Pilha de chamadas, você pode ver o escopo da política efetiva atual.

Se houver um erro durante a execução da política, você verá os detalhes do erro na política onde ele aconteceu.

exceções

Gorjeta

Lembre-se de sair da sessão de depuração clicando no botão Parar quando terminar.

Próximos passos