Compartilhar via

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

  • Artigo

APLICA-SE A: Desenvolvedor

As políticas no Gerenciamento de API do Azure fornecem recursos avançados que ajudam os editores de API a resolverem questões abrangentes, como autenticação, autorização, limitação, cache e transformação. As políticas são um conjunto de instruções executadas em sequência, na solicitação ou na resposta de uma API.

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

Pré-requisitos

Restrições e limitações

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

Importante

  • O Gerenciamento de API não dá mais suporte a assinaturas para rastreamento ou ao 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 com limite de tempo usando a API REST do Gerenciamento de API e passando o token em uma solicitação para o gateway. Para obter detalhes, confira Habilitar o rastreamento de uma API.
  • Tome cuidado ao habilitar o rastreamento, pois ele pode expor informações confidenciais nos dados de rastreamento. Verifique se você tem as medidas de segurança apropriadas em vigor para proteger os dados de rastreamento.

Iniciar uma sessão de depuração

  1. Iniciar o Visual Studio Code
  2. Navegue até a extensão de Gerenciamento de API em extensões do Azure
  3. Localize a instância de Gerenciamento de API a ser depurada
  4. Localize a API e a operação a serem depuradas
  5. Clique com o botão direito do mouse na operação e selecione Iniciar a 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 uma solicitação de teste

Quando a sessão de depuração for estabelecida, a extensão abrirá um novo editor que nos permite criar e enviar uma solicitação HTTP de teste para essa operação, aproveitando a extensão de 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 acesso total e de nível de serviço para disparar 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 uma solicitação 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 será interrompida na primeira política efetiva.

políticas de depuração

Para seguir o pipeline de política, você pode percorrer por políticas individuais ou definir um ponto de interrupção em uma política e passar 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 atual da política efetiva.

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

exceptions

Dica

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

Próximas etapas