Compartilhar via

Projetar e desenvolver APIs usando o plugin API Center para GitHub Copilot para Azure

  • Artigo

O plugin API Center para GitHub Copilot para Azure(versão prévia) acelera o design e o desenvolvimento de novas APIs a partir de prompts de linguagem natural. Com a assistência de IA disponível por meio do plug-in API Center combinado com a extensão VS Code do API Center, 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 no seu centro de API.

Observação

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

Pré-requisitos

Configuração de extensão

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

    Observação

    Onde indicado, certos recursos estão disponíveis apenas na versão prévia da extensão 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 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 exibição de Extensões.

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

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

  3. Se você não estiver conectado à sua conta do Azure, selecione Entrar no Azure... e siga os prompts para entrar. Selecione uma assinatura do Azure com o centro de APIs (ou centros de APIs) dos quais você deseja exibir as APIs. Você também pode filtrar em assinaturas específicas se tiver muitos para exibir.

Faça uma solicitação ao @azure agente

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

  1. Se desejar, defina um guia de estilo de API ativo na extensão do Azure API Center. Use o atalho de teclado Ctrl+Shift+P para abrir a Paleta de Comandos. Digite Centro de API do Azure: Definir o Guia de Estilo de 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 Especificação de API linting usando a extensão API Center.

  2. No painel de chat, faça uma solicitação em linguagem natural ao agente @azure 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 Copilot é alimentado por IA, portanto é passível de surpresas e erros. Para obter mais informações, confira Perguntas frequentes sobre o Copilot.

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

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

  3. Revise a saída gerada quanto à precisão, integridade e conformidade com seu guia de estilo de API.

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

    Dica

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

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

Registre a API no seu centro de API

Use a extensão do Azure API Center para VS Code para registrar a API no seu centro de API a partir do arquivo de especificação gerado. Após registrar a API, você pode usar a extensão para visualizar a documentação da API, gerar um cliente HTTP, executar mais linting e análises e muito mais.

  1. Selecione o botão Registrar sua API no Centro de API no painel de chat ou selecione Centro de API do Azure: registrar a API na Paleta de Comandos e siga os prompts.

  2. Selecione Manual.

  3. Selecione o centro de APIs para registrar APIs.

  4. Responda aos 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.

Após o registro da API, você pode executar diversas 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 API Center para selecionar a definição da 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 é exibida com a interface do usuário do Swagger para a definição de API.

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

Conteúdo relacionado