Tutorial: como usar o Gemini Code Assist para projetar, desenvolver e testar APIs na Apigee e no Cloud Code

Esta página se aplica à Apigee e à Apigee híbrida.

Visão geral

Neste tutorial, orientamos você no processo de uso do Gemini Code Assist no Cloud Code para projetar uma API e criar um proxy de API da Apigee a partir de uma especificação de API gerada. Neste tutorial, você usará um comando de linguagem natural para projetar e criar uma API que gerencie postagens de blog relacionadas a esportes para um site.

Antes de começar

Para concluir este tutorial, você precisará disto:

  • A API Cloud AI Companion configurada no seu projeto da Apigee ou ser um Administrador da organização da Apigee para poder adicioná-la. Para as etapas de configuração do Gemini Code Assist, consulte Usar o Gemini Code Assist.
  • Ser um Administrador de APIs da Apigee no projeto da Apigee.
  • Configurar o desenvolvimento local do seu projeto da Apigee no Cloud Code, caso ainda não tenha feito isso. Consulte Como configurar o gerenciamento de APIs da Apigee no Cloud Code para VS Code.
  • Conhecer as especificações da OpenAPI para poder analisar a especificação gerada.
  • (Opcional) Hub de APIs configurado nesse projeto. Embora isso não seja estritamente necessário para usar os recursos do Gemini Code Assist descritos aqui, não é possível realizar todas as etapas sem o hub de APIs.

Etapa 1: carregar a Apigee no Cloud Code

Abra o VS Code e clique no ícone do Cloud Code. Você verá o projeto da Apigee e as APIs.

Menu à esquerda do Gemini Code Assist do Cloud Code

Etapa 2: abrir a guia Criar uma especificação de API e inserir um comando

Clique na varinha mágica na linha da Apigee para abrir a guia de criação de especificações.

Varinha mágica de criação de especificações do Gemini Code Assist do Cloud Code

A guia mostra modelos que podem ser usados para iniciar o comando da API. Abaixo deles, há um campo de entrada de comando em formato livre. Clique em API para conteúdo do blog. Um comando de linguagem natural que descreve essa API é preenchido no campo de entrada do comando.

Formulário de criação do Gemini Code Assist do Cloud Code

Etapa 3: criar e ver a especificação

Clique em Criar para gerar uma especificação de API com base nesse comando. Aguarde enquanto a especificação é gerada. O painel Saída mostra as etapas à medida que a especificação é criada.

Depois de criada, role para baixo para ver os endpoints, esquemas e a descrição da especificação. Para ver o código da especificação da OpenAPI, clique em Ver código.

Endpoints da especificação do Gemini Code Assist do Cloud Code

Etapa 4: modificar o comando e recriar a especificação

Volte para o comando e adicione o tipo de esporte ao objeto de dados.

Comando editado do Gemini Code Assist do Cloud Code

Clique em Criar mais uma vez para gerar a especificação outra vez. Você verá o tipo de esporte na especificação atualizada.

Também é possível voltar ao comando anterior clicando no histórico de comando na parte de cima da caixa de entrada de comandos.

Etapa 5: editar a especificação

É possível alterar a especificação clicando em Ver código e digitando as atualizações diretamente na especificação. Nesse exemplo, mude a descrição para "API de gerenciamento de conteúdo de postagens dos blogs de esporte".

Código editado do Gemini Code Assist do Cloud Code

Etapa 6: testar a API usando um servidor simulado

Teste a API usando o servidor simulado local, que emula respostas para a API. No menu suspenso Servidores, selecione a opção com Servidor de desenvolvimento local no nome. Depois de selecioná-lo, abra o caminho POST e clique em Testar.

Modifique os valores "author", "content" e "title" no corpo da solicitação para usar seus próprios valores:

{
    "author": "My name",
    "categories": [
      "string"
    ],
    "content": "This is my blog post",
    "featuredImageUrl": "string",
    "publishedDate": "string",
    "tags": [
      "string"
    ],
    "title": "Baseball in the age of AI"
  }

Clique em Executar para ver uma resposta fictícia da API na seção Respostas.

Etapa 7: salvar a API no hub de APIs

(Opcional) Após a revisão e finalização da sua API, registre-a no hub de APIs para disponibilizá-la aos desenvolvedores:

  1. Clique em Registrar no hub de APIs.
  2. Siga as instruções para registrar a API. Consulte Registrar APIs para informações sobre o registro no hub de APIs e os dados que você precisa fornecer.

Clique em Salvar para salvar a nova API com um nome que você preferir.

Etapa 8: criar um pacote de proxy de API com base nesta especificação

Para criar um pacote de proxies de API da Apigee com base nessa especificação, clique em Criar pacote de proxies de API no menu Mais. Após a criação, o novo proxy aparecerá em apiproxies no menu à esquerda. Consulte Como desenvolver proxies de API para informações sobre como trabalhar com proxies de API no Cloud Code.
Pacote de proxies de API de criação do Gemini Code Assist do Cloud Code

Próximas etapas