Partilhar via

Habilitar e exibir a exibição do portal do Centro de API do Azure - extensão VS Code

Este artigo mostra como fornecer aos desenvolvedores corporativos acesso ao modo de exibição do portal do Centro de API do Azure na extensão de código do Visual Studio para o Centro de API do Azure. Usando o modo de exibição do portal, os desenvolvedores podem descobrir APIs em seu 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 APIs ou adicionar APIs ao inventário. O acesso à vista do portal do Centro de API é gerido através do Microsoft Entra ID e do controle de acesso baseado em funções do Azure.

Sugestão

A extensão Visual Studio Code fornece mais recursos para desenvolvedores de API que têm permissões para gerenciar uma central de API do Azure. Por exemplo, os desenvolvedores de API podem registrar APIs no centro de APIs diretamente ou usando pipelines de CI/CD. Saiba mais

Pré-requisitos

Para administradores do centro de API

  • Um centro de API na sua subscrição do Azure. Se você ainda não criou um, consulte Guia de início rápido: criar sua central de API.

  • Permissões para criar um registo de aplicação num tenant do Microsoft Entra associado à sua subscrição do Azure e permissões para conceder acesso aos dados no seu centro de APIs.

Para desenvolvedores de aplicativos

As seguintes extensões de código do Visual Studio são opcionais:

Etapas para os administradores do Centro de API habilitarem o acesso à exibição do portal do Centro de API

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 APIs.

Criar registo da aplicação Microsoft Entra

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

A Central de APIs pode configurar o registro do aplicativo automaticamente ou você pode criar o registro do aplicativo manualmente.

Configurar o registo da aplicação automaticamente

Para configurar o registo da aplicação automaticamente, siga estes passos:

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

Se precisar de aceder ao registo da aplicação mais tarde, pode encontrá-la no portal em Registos da aplicação. O aplicativo é nomeado com o seguinte formato: <api-center-name-apic-aad>.

Configurar o registo da aplicação manualmente

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

  1. No portal do Azure, navegue até Microsoft Entra ID>Gerir>Registos de Aplicativos.

  2. Selecione + Novo registo.

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

    1. Defina Name como um nome significativo, como api-center-portal
    2. Em Tipos de conta suportados, selecione Contas somente neste diretório organizacional (<Nome do diretório> - Locatário único).
    3. Em Redirecionar URI, selecione Aplicativo de página única (SPA) e defina o URI. Insira o URI da implantação do portal do Centro de APIs, no seguinte formato: https://<service-name>.portal.<location>.azure-apicenter.ms. Substitua <service name> e <location> pelo nome do seu centro de API e o local onde ele foi implantado, Exemplo: https://myapicenter.portal.eastus.azure-apicenter.ms.
    4. Selecione Registrar.

Configurar URIs de redirecionamento adicionais para extensão VS Code

Ao habilitar a exibição do portal da Central de APIs na extensão de código do Visual Studio para a Central de APIs, configure também os seguintes URIs de redirecionamento no registro do aplicativo:

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

  2. Na página Gerir>Autenticação , selecione Adicionar uma plataforma e selecione Aplicações móveis e de ambiente de trabalho.

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

    Substitua <application-client-id> pelo ID da aplicação (cliente) deste programa. Você pode encontrar esse valor na página Visão geral do registro do aplicativo.

Habilitar o login no portal do Centro de APIs para utilizadores e grupos do Microsoft Entra

Desenvolvedores empresariais devem iniciar sessão com uma conta Microsoft para aceder à vista do portal do seu Centro de API. Se necessário, adicione ou convide desenvolvedores para seu locatário do Microsoft Entra.

Para habilitar a entrada no portal do Centro de APIs 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 centro de APIs.

Importante

Por padrão, você e outros administradores do centro de API devem entrar para acessar APIs no portal do Centro de APIs. Certifique-se de atribuir a função de Leitor de Dados do Centro de API do Azure a si mesmo e a outros administradores.

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

  1. No portal do Azure, navegue até o centro de APIs.
  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 forma:
    1. Na página Função , procure e selecione Leitor de Dados do Centro de API do Azure. Selecione Avançar.
    2. Na página Membros, em Atribuir acesso a, selecione Utilizador, grupo ou entidade de segurança>+ 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 seguida, em Avançar.
    4. Reveja a atribuição de função e selecione Rever + atribuir.

Observação

Para simplificar a configuração de acesso para novos usuários, recomendamos que você atribua a função a um grupo do Microsoft Entra e configure uma regra de associação de grupo dinâmico. Para saber mais, consulte Criar ou atualizar um grupo dinâmico no Microsoft Entra ID.

Depois de configurar o acesso ao portal, os usuários configurados podem entrar no portal e exibir as APIs em seu centro de APIs.

Observação

O primeiro usuário a entrar no portal é solicitado a consentir com as permissões solicitadas pelo registro do aplicativo do portal da Central de APIs. Depois disso, outros usuários configurados não são solicitados a consentir.

Etapas para desenvolvedores corporativos acessarem a exibição do portal da Central de APIs

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

Conectar-se a um centro de API

  1. No Visual Studio Code, na barra de atividades à esquerda, selecione Central de APIs.

    Captura de ecrã do ícone do Centro de API na Barra de Atividades.

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

  3. Responda às solicitações para inserir as seguintes informações:

    1. A URL de tempo de execução do seu 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. Esta URL de tempo de execução aparece na página Visão geral do centro de API na vista do portal do Azure.

    2. O ID da aplicação (cliente) do registo da aplicação configurado pelo administrador na secção anterior.

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

    Sugestão

    Um administrador do centro de API precisa fornecer os detalhes da conexão anterior 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 aparece na exibição do portal do Centro de API.

  4. Para exibir as APIs no centro de APIs, sob o nome do centro de APIs, selecione Entrar no Azure. O início de sessão é permitido com uma conta Microsoft à qual é atribuída a função de Leitor de Dados do Centro de API do Azure no Centro de API.

    Captura de ecrã da vista do portal do Centro de API na extensão do Centro de API.

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

    Captura de ecrã das definições da API no Centro de APIs na extensão do Centro de APIs.

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

Descobrir e consumir APIs na visualização do portal do Centro de APIs

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

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

Usar ferramentas de modelo de linguagem

Os desenvolvedores com acesso à exibição do portal do Centro de API podem adicionar ferramentas de modelo de linguagem do Centro de API para usar 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 as ferramentas do modo de idioma 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 bate-papo do copiloto do GitHub no Visual Studio Code.

  3. Defina o modo de bate-papo do copiloto do GitHub como Agente.

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

    Captura de tela da janela de bate-papo do GitHub Copilot no Visual Studio Code.

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

    Captura de tela da seleção de ferramentas da Central de API no Visual Studio Code.

  6. Insira um prompt na janela de bate-papo 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. Reveja as respostas do GitHub Copilot Chat. Continue com a conversa para refinar os resultados ou fazer perguntas de acompanhamento.

Solução de problemas

Não é possível entrar no Azure

Se os usuários aos quais foi atribuída 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 na exibição do portal do Centro de APIs, pode haver um problema com a configuração da conexão.

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

Conteúdo relacionado

  • Last updated on