Tutorial: Utilizzo di Gemini Code Assist per progettare, sviluppare e testare le API in Apigee e Cloud Code

Questa pagina si applica a Apigee e Apigee ibrido.

Panoramica

Questo tutorial ti guida nel processo di utilizzo di Gemini Code Assist in Cloud Code per progettare un'API e creare un proxy API Apigee da una specifica API generata. In questo tutorial utilizzerai un prompt in linguaggio naturale per progettare e creare un'API che gestisca i post di blog relativi allo sport per un sito web.

Prima di iniziare

Per completare questo tutorial, avrai bisogno di:

  • L'API Cloud AI Companion configurata per il tuo progetto Apigee o puoi essere un amministratore dell'organizzazione Apigee in modo da poterla aggiungere. Per i passaggi di configurazione di Gemini Code Assist, consulta Utilizzare Gemini Code Assist.
  • Essere un amministratore dell'API Apigee nel tuo progetto Apigee.
  • Per configurare lo sviluppo locale per il tuo progetto Apigee in Cloud Code, se non l'hai ancora fatto, consulta la pagina relativa alla configurazione della gestione delle API Apigee in Cloud Code per VS Code.
  • Familiarità con le specifiche OpenAPI, per poter rivedere le specifiche generate.
  • (Facoltativo) Hub API configurato per questo progetto. Sebbene non sia strettamente necessario per utilizzare le funzionalità di Gemini Code Assist descritte qui, non potrai eseguire tutti i passaggi senza l'hub API.

Passaggio 1: carica Apigee in Cloud Code

Apri VS Code e fai clic sull'icona Cloud Code. Dovresti vedere il tuo progetto Apigee ed eventuali API.

Menu a sinistra di Gemini Code Assist di Cloud Code

Passaggio 2: apri la scheda Crea una specifica API e inserisci un prompt

Fai clic sulla bacchetta magica nella riga Apigee per aprire la scheda di creazione delle specifiche.

Gemini Code Assist di Cloud Code per la creazione di una bacchetta magica delle specifiche

La scheda mostra i modelli che puoi utilizzare per avviare il prompt dell'API. Sotto di loro è disponibile un campo di immissione dei prompt in formato libero. Fai clic su API per i contenuti del blog. Un prompt in linguaggio naturale che descrive questa API viene compilato nel campo di immissione del prompt.

Modulo delle specifiche di creazione di Gemini Code Assist di Cloud Code

Passaggio 3: crea e visualizza le specifiche

Fai clic su Crea per generare una specifica API da questo prompt. Attendi che venga generata la specifica. Il riquadro Output mostra i passaggi man mano che viene creata la specifica.

Dopodiché, visualizza la descrizione delle specifiche, gli endpoint e gli schemi scorrendo verso il basso. Per visualizzare il codice della specifica OpenAPI, fai clic su Visualizza codice.

Endpoint specifiche di Cloud Code Gemini Code Assist

Passaggio 4: modifica il prompt e ricrea la specifica

Torna al prompt e aggiungi il tipo sport come parte dell'oggetto dati.

Prompt modificato di Gemini Code Assist di Cloud Code

Fai di nuovo clic su Crea per rigenerare la specifica. Vedrai il tipo di sport nella specifica aggiornata.

Tieni presente che puoi anche tornare al prompt precedente facendo clic sulla cronologia dei prompt nella parte superiore della casella di immissione del prompt.

Passaggio 5: modifica le specifiche

Puoi modificare le specifiche facendo clic su Visualizza codice e digitando i tuoi aggiornamenti direttamente nelle specifiche. Per questo esempio, modifica la descrizione in "API Sports Blog Post Content Management".

Codice modificato con Gemini Code Assist di Cloud Code

Passaggio 6: testa l'API utilizzando un server fittizio

Testa l'API utilizzando il server simulato locale, che emula le risposte per l'API. Nel menu a discesa Server, seleziona l'opzione che contiene Server di sviluppo locale nel nome. Una volta selezionato, apri il percorso POST e fai clic su Prova.

Modifica i valori "author", "content" e "title" nel corpo della richiesta per utilizzare i tuoi valori:

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

Fai clic su Esegui per visualizzare una risposta simulata dell'API nella sezione Risposte.

Passaggio 7: salva l'API nell'hub API

(Facoltativo) Una volta che l'API è stata esaminata e definitiva, rendila disponibile agli sviluppatori registrandola nell'hub API:

  1. Fai clic su Registrati all'hub API.
  2. Segui le istruzioni per registrare l'API. Consulta la pagina Registrazione delle API per informazioni sulla registrazione con l'hub API e per le informazioni da fornire.

Fai clic su Salva per salvare la nuova API con un nome a tua scelta.

Passaggio 8: crea un bundle proxy API da questa specifica

Per creare un proxy proxy API Apigee da questa specifica, fai clic su Crea bundle proxy API dal menu Altro. Dopo la creazione, dovresti vedere il nuovo proxy in apiproxies nel menu a sinistra. Per informazioni sull'utilizzo dei proxy API in Cloud Code, consulta Sviluppo di proxy API.
Bundle proxy API per la creazione di Gemini Code Assist di Cloud Code

Passaggi successivi