Ativar e visualizar a visualização do portal do Centro de API do Azure – extensão do Visual Studio Code

Este artigo mostra como fornecer aos desenvolvedores corporativos acesso à exibição do portal do Centro de API do Azure na extensão do Visual Studio Code para o Centro de API do Azure. Usando a exibição do portal, os desenvolvedores podem descobrir APIs no centro de API do Azure, exibir definições de API e, opcionalmente, gerar clientes de API quando não tiverem acesso para gerenciar o próprio centro de API ou adicionar APIs ao inventário. O acesso à visualização do portal do Centro de API é gerenciado usando o Microsoft Entra ID e o controle de acesso baseado em funções do Azure.

Pré-requisitos

Para administradores do centro de API

• Um centro de API na sua assinatura do Azure. Se você ainda não criou um, consulte Início Rápido: criar seu centro de API.

• Permissões para criar uma inscrição de aplicativo em um tenant do Microsoft Entra associado à sua assinatura do Azure e permissões para conceder acesso aos dados na central de APIs.

Para desenvolvedores de aplicativos

• Extensão do Centro de API do Azure para Visual Studio Code

As seguintes extensões do Visual Studio Code são opcionais:

• Extensão do Microsoft Kiota – para gerar clientes de API
• GitHub Copilot e GitHub Copilot Chat, fornecidos com acesso ao GitHub Copilot – para usar ferramentas de modelo de linguagem no modo de agente para descobrir APIs

Etapas para que os administradores do API Center habilitem o acesso à visão do portal do API Center

As seções a seguir fornecem etapas para que os administradores do centro de API permitam que os desenvolvedores corporativos acessem a exibição do portal do Centro de API.

Criar registro de aplicativo do Microsoft Entra

Primeiro, configure um registro de aplicativo no locatário do Microsoft Entra ID. O registro do aplicativo permite que o portal do Centro de API acesse dados do centro de API em nome de um usuário conectado.

O Centro de API pode configurar o registro do aplicativo automaticamente ou você pode criar o registro do aplicativo manualmente.

Configurar o registro do aplicativo automaticamente

Para configurar o registro do aplicativo automaticamente, siga estas etapas:

1. No portal do Azure, navegue até o centro de API.
2. No menu à esquerda, selecioneConfigurações do portal > do Centro de API.
3. Na guia Provedor de identidade , selecione Iniciar configuração.
4. Na guia Configuração rápida, selecione Salvar + publicar.

Se você precisar acessar o registro do aplicativo mais tarde, poderá encontrá-lo no portal em Registros de aplicativo. O aplicativo é nomeado com o seguinte formato: <api-center-name-apic-aad>.

Configurar o registro do aplicativo manualmente

Se você quiser criar o registro do aplicativo manualmente, siga estas etapas:

1. No portal do Azure, navegue até o Microsoft Entra ID>Gerenciar>Registros de aplicativo.

2. Selecione + Novo registro.

3. Na página Registrar um aplicativo, defina os valores da seguinte forma:

   1. Definir Nome como um nome significativo, como api-center-portal
   2. Em Tipos de contas suportados, selecione Contas apenas neste diretório organizacional (<Nome do diretório> - Locatário único).
   3. No URI de Redirecionamento, selecione SPA (aplicativo de página única) e defina o URI. Insira o URI da implantação do portal do Centro de API no seguinte formulário: https://<service-name>.portal.<location>.azure-apicenter.ms. Substitua <service name> e <location> pelo nome do centro de API e o local onde ele é implantado, exemplo: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Selecione Registrar.

Configurar URIs de redirecionamento adicionais para a extensão do VS Code

Ao habilitar a exibição do portal do Centro de API na extensão do Visual Studio Code para o Centro de API, configure também as seguintes URIs de redirecionamento no registro do aplicativo:

1. No portal do Azure, navegue até o registro do aplicativo.

2. Na página Gerenciar>Autenticação , selecione Adicionar uma plataforma e selecione Aplicativos móveis e de área de trabalho.

3. Configure as seguintes três URIs de redirecionamento personalizadas:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Substitua <application-client-id> pela ID do cliente deste aplicativo. Você pode encontrar esse valor na página Visão geral do registro do aplicativo.

Habilitar a entrada no modo de exibição do portal do Centro de API por usuários e grupos do Microsoft Entra

Os desenvolvedores corporativos devem entrar com uma conta Microsoft para ver a exibição do portal do Centro de API para o seu centro de API. Se necessário, adicione ou convide desenvolvedores ao seu locatário do Microsoft Entra.

Para habilitar a entrada no portal do Centro de API para acessar APIs, atribua a função Leitor de Dados do Centro de API do Azure a usuários ou grupos em sua organização, com escopo para o seu centro de API.

Para obter pré-requisitos e etapas detalhados para atribuir uma função a usuários e grupos, consulte Atribuir funções do Azure usando o portal do Azure. Etapas breves a seguir:

1. No portal do Azure, navegue até o centro de API.
2. No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar atribuição de função.
3. No painel Adicionar atribuição de função , defina os valores da seguinte maneira:
   1. Na página Função , pesquise e selecione Leitor de Dados do Centro de API do Azure. Selecione Próximo.
   2. Na página Membros, em Atribuir acesso a, selecione Usuário, grupo ou entidade de serviço>+ Selecionar membros.
   3. Na página Selecionar membros, pesquise e selecione os usuários ou grupos aos quais atribuir a função. Clique em Selecionar e em Avançar.
   4. Examine a atribuição de função e selecione Examinar + atribuir.

Depois de configurar o acesso ao portal, os usuários configurados poderão entrar no portal e exibir as APIs no centro de API.

Etapas para os desenvolvedores corporativos acessarem a exibição do portal do Centro de API

Os desenvolvedores podem seguir estas etapas para se conectar e entrar em uma exibição do portal do Centro de API usando a extensão do Visual Studio Code. As configurações para se conectar ao centro de API precisam ser fornecidas pelo administrador do centro de API. Após a conexão, os desenvolvedores podem descobrir e consumir as APIs no centro de API.

Conectar-se a um centro de API

1. No Visual Studio Code, na Barra de Atividades à esquerda, selecione Centro de API.

   

2. Use o atalho de teclado Ctrl+Shift+P para abrir a Paleta de Comandos. Digite o Centro de API do Azure: conecte-se a um Centro de API e pressione Enter.

3. Responda aos prompts para inserir as seguintes informações:

   1. A URL de runtime do centro de API, no formato <service name>.data.<region>.azure-apicenter.ms (não prefixe com https://). Exemplo: contoso-apic.data.eastus.azure-apicenter.ms. Essa URL de runtime é exibida na página Visão geral do centro de API no modo de exibição do portal do Azure.

   2. A ID do aplicativo (cliente) do registro do aplicativo configurado pelo administrador na seção anterior.

   3. A ID do diretório (locatário) do registro do aplicativo configurado pelo administrador na seção anterior.

   Dica

   Um administrador do centro de API precisa fornecer os detalhes de conexão anteriores aos desenvolvedores ou fornecer um link direto no seguinte formato:
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   Depois de se conectar ao Centro de API, o nome do Centro de API será exibido na visualização do portal do Centro de API.

4. Para exibir as APIs no centro de API, no nome do centro de API, selecione Entrar no Azure. A entrada é permitida com uma conta da Microsoft que possui a função Leitor de Dados do Azure API Center no centro de API.

   

5. Depois de entrar, selecione APIs para listar as APIs no centro de API. Expanda uma API para explorar suas versões e definições.

   

6. Repita as etapas anteriores para se conectar a mais centros de API, se o acesso estiver configurado.

Descobrir e consumir APIs na visão do portal da Central de APIs

A exibição do portal do Centro de API ajuda os desenvolvedores corporativos a descobrir detalhes da API e iniciar o desenvolvimento do cliente de API. Os desenvolvedores podem acessar os seguintes recursos clicando com o botão direito do mouse em uma definição de API no modo de exibição do portal do Centro de API:

• Exportar documento de especificação de API – Exportar uma especificação de API de uma definição e, em seguida, baixá-la como um arquivo
• Gerar cliente de API – Usar a extensão do Microsoft Kiota para gerar um cliente de API para seu idioma favorito
• Gerar Markdown – Gerar documentação da API no formato Markdown
• Documentação do OpenAPI – Exibir a documentação de uma definição de API e testar operações em uma interface do usuário do Swagger (disponível apenas para definições do OpenAPI)

Usar ferramentas de modelo de linguagem

Os desenvolvedores com acesso ao modo de exibição do portal do Centro de API podem adicionar ferramentas de modelo de linguagem do Centro de API a serem usadas no modo de agente do GitHub Copilot. Saiba mais sobre como usar ferramentas no modo de agente.

As ferramentas do Centro de API podem ser usadas no modo de agente para ajudar a pesquisar APIs e versões de API, definições e especificações de API, implantações e muito mais usando prompts de linguagem natural.

Para adicionar e usar ferramentas de modo de linguagem do Centro de API no modo de agente do GitHub Copilot:

1. Conecte-se a um centro de API , conforme descrito em uma seção anterior.

2. Abra o GitHub Copilot Chat no Visual Studio Code.

3. Defina o modo do GitHub Copilot Chat como Agent.

4. Selecione o ícone Ferramentas na janela de chat.

   

5. Selecione uma ou mais ferramentas do Centro de API para estar disponível no chat.

   

6. Insira um prompt na janela de chat para usar as ferramentas disponíveis. Por exemplo:

   Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
   

7. Examine as respostas do GitHub Copilot Chat. Continue com a conversa para refinar os resultados ou fazer perguntas de acompanhamento.

Resolução de problemas

Não é possível entrar no Azure

Se os usuários que receberam a função leitor de dados do Centro de API do Azure não puderem concluir o fluxo de entrada depois de selecionar entrar no Azure no modo de exibição do portal do Centro de API, pode haver um problema com a configuração da conexão.

Verifique as configurações no registro do aplicativo que você configurou na ID do Microsoft Entra. Confirme os valores da ID do aplicativo (cliente) e a ID do diretório (locatário) no registro do aplicativo e na URL de runtime do centro de API. Em seguida, configure a conexão com o centro de API novamente.

Conteúdo relacionado

• Criar e registrar APIs com a extensão do Centro de API do Azure para Visual Studio Code

• Práticas Recomendadas para RBAC do Azure

• Registrar um provedor de recursos