Partilhar via

Projetar e desenvolver APIs usando o plug-in do Centro de API para o GitHub Copilot para Azure

  • Artigo

O plug-in do Centro de API para o GitHub Copilot para Azure (visualização) acelera o design e o desenvolvimento de novas APIs a partir de prompts de linguagem natural. Com a assistência de IA disponível através do plug-in do Centro de API combinado com a extensão VS Code do Centro de API, basta descrever sua API e gerar rapidamente uma especificação OpenAPI para desenvolvimento de API que esteja em conformidade com os padrões da sua organização. Depois de gerar uma especificação compatível, você pode registrar a API com seu centro de API.

Nota

Esse recurso está disponível na versão de pré-lançamento da extensão do Centro de APIs.

Pré-requisitos

Configuração da extensão

  1. Instale a extensão do Centro de API do Azure para Visual Studio Code a partir do Visual Studio Code Marketplace. Instale outras extensões listadas nos Pré-requisitos.

    Nota

    Quando observado, determinados recursos estão disponíveis somente na versão de pré-lançamento da extensão do Centro de API do Azure. Ao instalar a extensão do Visual Studio Code Marketplace, você pode optar por instalar a versão de lançamento ou uma versão de pré-lançamento. Alterne entre as duas versões a qualquer momento usando o menu de contexto do botão Gerenciar da extensão na visualização Extensões.

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

    Captura de ecrã da extensão do Centro de API na barra de atividades.

  3. Se não tiver sessão iniciada na sua conta do Azure, selecione Iniciar sessão no Azure..., e siga as instruções para iniciar sessão. Selecione uma assinatura do Azure com o centro de API (ou centros de API) do qual você deseja exibir APIs. Também pode filtrar subscrições específicas se tiver muitas para visualizar.

Fazer pedido ao @azure agente

Siga estas etapas para gerar uma especificação OpenAPI usando prompts de linguagem natural com o GitHub Copilot for Azure:

  1. Se desejar, defina um guia de estilo de API ativo na extensão do Centro de API do Azure. Use o atalho de teclado Ctrl+Shift+P para abrir a Paleta de Comandos. Digite Central de API do Azure: defina o Guia de Estilo da API, faça uma seleção e pressione Enter.

    Se nenhum guia de estilo for definido, o conjunto de regras padrão spectral:oas será usado. Saiba mais sobre o revestimento de especificação de API usando a extensão do Centro de API.

  2. No painel de chat, faça uma solicitação em linguagem natural ao @azure agente para descrever o que a API faz. Exemplo:

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    O copiloto é alimentado por IA, por isso surpresas e erros são possíveis. Para obter mais informações, consulte Perguntas frequentes sobre o Copilot.

    O agente responde com um documento de especificação OpenAPI.

    Captura de tela mostrando como usar @azure extensão para gerar uma especificação OpenAPI a partir de um prompt.

  3. Analise a saída gerada para verificar se há precisão, integridade e conformidade com o guia de estilo da API.

    Refine o prompt, se necessário, para regenerar a especificação ou repita o processo usando um guia de estilo diferente definido na extensão do Centro de API do Azure.

    Gorjeta

    Os prompts eficazes se concentram nos requisitos de negócios de uma API, em vez de nos detalhes da implementação. Prompts mais curtos às vezes funcionam melhor do que os mais longos.

  4. Quando atender aos seus requisitos, salve a especificação OpenAPI gerada em um arquivo.

Registre a API em seu centro de API

Use a extensão do Centro de API do Azure para VS Code para registrar a API em seu centro de API a partir do arquivo de especificação gerado. Depois de registrar a API, você pode usar a extensão para visualizar a documentação da API, gerar um cliente HTTP, executar forros e análises adicionais e muito mais.

  1. No VS Code, selecione o botão Registrar sua API na Central de APIs no painel de chat ou selecione Central de API do Azure: Registrar API na Paleta de Comandos.

  2. Selecione Manual.

  3. Selecione o centro de API com o qual registrar APIs.

  4. Responda prompts com informações, incluindo título da API, tipo, título da versão, ciclo de vida da versão, título da definição, nome da especificação e arquivo de definição (especificação) para concluir o registro da API.

Depois que a API é registrada, você pode executar várias tarefas usando a extensão. Por exemplo, veja a documentação da API na interface do usuário do Swagger:

  1. Expanda a visualização em árvore do Centro de API para selecionar a definição para a versão da API que você registrou.

  2. Clique com o botão direito do mouse na definição e selecione Abrir documentação da API. Uma nova guia aparece com a interface do usuário do Swagger para a definição da API.

Captura de tela da interface do usuário do Swagger na extensão VS Code.

Conteúdos relacionados