Criar, entender e depurar políticas de Gerenciamento de API do Azure no Visual Studio Code

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo explica como usar a extensão API Management do Azure para Visual Studio Code para criar, compreender e depurar políticas de Gestão de APIs. A extensão integra-se com GitHub Copilot para Azure para ajudar a redigir e explicar políticas.

Uma API Management do Azure política é uma sequência de instruções que abordam preocupações transversais aplicadas a pedidos ou respostas da API. Estas preocupações incluem autenticação, autorização, limitação, armazenamento em cache e transformação.

Pré-requisitos

• Visual Studio Code.

• A versão mais recente da extensão API Management do Azure para Visual Studio Code.

• As seguintes extensões são necessárias para os cenários especificados:

  • GitHub Copilot para Azure extensão para criar e explicar políticas
  • Extensão do cliente REST para depuração de políticas

• Uma instância de gerenciamento de API. Se precisares de criar uma, vê Criar uma nova instância API Management do Azure.

• Importe uma API para sua instância de Gerenciamento de API. Consulte Utilize a extensão de gestão de APIs para Visual Studio Code para importar e gerir APIs.

Restrições e limitações

• Atualmente, a depuração de políticas é suportada apenas na camada do Desenvolvedor de Gerenciamento de API.

• A depuração de políticas utiliza a subscrição de acesso total integrada (ao nível de serviço), que tem o nome de exibição Assinatura de acesso total integrada. Tem de ser proprietário de um serviço para utilizar esta subscrição.

Criar uma política usando o GitHub Copilot para Azure

A extensão Gerenciamento de API do Azure integra-se ao GitHub Copilot para Azure para ajudá-lo a criar um rascunho de uma política. Com a assistência de IA, crie e edite políticas de forma amigável.

Para criar uma política:

1. Abra a extensão Gerenciamento de API no Visual Studio Code.

2. Selecione a instância de Gerenciamento de API com a qual deseja trabalhar.

3. Selecione o escopo da política com o qual você deseja trabalhar.

   • Para criar uma política que se aplique a todas as APIs na instância, selecione Política Global.
   • Para criar uma política que se aplique a uma API específica, em APIs, selecione a API e, em seguida, selecione Política.
   • Para criar uma política que se aplique a uma operação de API específica, selecione a operação e, em seguida, selecione Política.

4. Abra o bate-papo.

5. Na janela Chat, insira um prompt em linguagem natural para criar uma política. Examples:

   @azure I want to limit requests to 100 calls per minute
   

   @azure Create a policy that sets the backend URL to https://mybackend.contoso.com and adds a custom header to the request
   

   O Copilot gera um rascunho de política na janela de bate-papo. Você pode refinar o prompt se quiser que o Copilot altere a saída.

6. Quando estiver pronto, selecione o botão Copiar para copiar a política para a área de transferência ou selecione Aplicar no Editor para inserir a política na janela do editor. Se estiver satisfeito com a alteração no ficheiro XML de política, selecione Manter.

Explicar uma política usando o GitHub Copilot para Azure

O Copilot pode ajudar a explicar uma política existente em sua instância de Gerenciamento de API.

Para receber uma explicação:

1. Abra a extensão Gerenciamento de API no Visual Studio Code.

2. Selecione a instância de Gerenciamento de API com a qual deseja trabalhar.

3. Selecione o escopo da política com o qual você deseja trabalhar.

   • Para explicar uma política que se aplica a todas as APIs na instância, selecione Política Global.
   • Para explicar uma política que se aplica a uma API específica, em APIs, selecione a API e, em seguida, selecione Política.
   • Para explicar uma política que se aplica a uma operação de API específica, selecione a operação e, em seguida, selecione Política.

4. Na janela do editor de políticas que aparece, clique com o botão direito e selecione Explicar.

5. Uma visão geral e uma explicação das políticas no documento XML da política são geradas na janela Chat.

Políticas de depuração usando a extensão VS Code

A extensão de Gerenciamento de API do Azure para Visual Studio Code fornece uma experiência de depuração que permite percorrer o pipeline de políticas ou definir um ponto de paragem ao enviar uma solicitação para o gateway.

Iniciar uma sessão de depuração

1. Abra a extensão Gerenciamento de API no Visual Studio Code.
2. Selecione a instância de Gestão de API a ser analisada.
3. Selecione a API e a operação para depurar.
4. Clique com o botão direito na operação e selecione Iniciar Depuração de Políticas.

A extensão começa a estabelecer uma sessão de depuração com o API Management gateway. Verifique o progresso na janela Debug Console .

Enviar um pedido de teste

Quando a sessão de depuração é estabelecida, a extensão do cliente REST abre um novo editor que permite criar e enviar uma solicitação HTTP de teste para o gateway.

O cabeçalho Ocp-Apim-Debug é adicionado automaticamente à solicitação. Este cabeçalho é necessário e o valor deve ser definido como a chave de subscrição de acesso total a nível de serviço para acionar a funcionalidade de depuração no gateway de Gestão de API.

Modifique a solicitação HTTP no editor de acordo com seu cenário de teste. Depois seleciona Enviar Pedido para enviar o pedido de teste para o gateway de Gestão de APIs.

Políticas de depuração

Depois que a solicitação HTTP de teste é enviada, a extensão abre a janela de depuração, que mostra as políticas efetivas dessa operação e para na primeira política efetiva.

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 , inspecione os valores das variáveis criadas pelo sistema e pelo usuário.
• No painel de pontos de interrupção , veja a lista de todos os pontos de interrupção que definiu.
• No painel Pilha de chamadas, visualize o escopo da política efetiva atual.

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

Para sair da sessão de depuração, selecione Parar.

Conteúdo relacionado

• Saiba mais sobre a extensão API Management para Visual Studio Code
• Relatar problemas no repositório GitHub