Tutoriel : Utiliser Gemini Code Assist pour concevoir, développer et tester des API dans Apigee et Cloud Code

Cette page s'applique à Apigee et à Apigee hybrid.

Présentation

Ce tutoriel vous guide tout au long du processus d'utilisation de Gemini Code Assist dans Cloud Code pour concevoir une API et créer un proxy d'API Apigee à partir d'une spécification d'API générée. Dans ce tutoriel, vous allez utiliser une requête en langage naturel pour concevoir et créer une API qui gère la publication de articles de blog liés au sport pour un site Web.

Avant de commencer

Pour réaliser ce tutoriel, vous devez disposer des éléments suivants :

  • L'API Cloud AI Companion doit être configurée pour votre projet Apigee, ou vous devez être administrateur de l'organisation Apigee pour pouvoir l'ajouter. Pour connaître les étapes de configuration de Gemini Code Assist, consultez la page Utiliser Gemini Code Assist.
  • être administrateur des API Apigee sur votre projet Apigee ;
  • le développement local de votre projet Apigee doit être configuré dans Cloud Code, si vous ne l'avez pas déjà fait, consultez Configurer Apigee API Management dans Cloud Code pour VS Code.
  • Vous devez connaître les spécifications OpenAPI pour pouvoir examiner la spécification générée.
  • (Facultatif) Hub d'API configuré pour ce projet. Bien que cela ne soit pas strictement obligatoire pour utiliser les fonctionnalités de Gemini Code Assist décrites ici, vous ne pourrez pas effectuer toutes les étapes sans le hub d'API.

Étape 1 : Chargez Apigee dans Cloud Code

Ouvrez VS Code et cliquez sur l'icône Cloud Code. Votre projet Apigee et vos API doivent s'afficher.

Menu de gauche de Cloud Code Gemini Code Assist

Étape 2: Ouvrez l'onglet Créer une spécification d'API et saisissez une requête.

Cliquez sur la baguette magique dans la ligne Apigee pour ouvrir l'onglet de création de spécification.

Baguette magique Cloud Code Gemini Code Assist pour créer des spécifications

Cet onglet affiche les modèles que vous pouvez utiliser pour lancer la requête d'API. Un champ de saisie de requête de format libre est disponible en dessous. Cliquez sur API pour le contenu de blog. Une requête en langage naturel décrivant cette API est renseignée dans le champ de saisie de la requête.

Formulaire de création de spécifications dans Cloud Code Gemini Code Assist

Étape 3: Créer et afficher la spécification

Cliquez sur Créer pour générer une spécification d'API à partir de cette requête. Attendez que la spécification soit générée. Le panneau Résultat affiche les étapes à mesure que la spécification est créée.

Une fois la spécification créée, affichez la description de la spécification, les points de terminaison et les schémas en faisant défiler la page vers le bas. Pour afficher le code de la spécification OpenAPI, cliquez sur Afficher le code.

Points de terminaison de spécification dans Cloud Code Gemini Code Assist

Étape 4: Modifiez la requête et recréez la spécification

Revenez à la requête et ajoutez le type de sport dans l'objet de données.

Modification de requête dans Cloud Code Gemini Code Assist

Cliquez à nouveau sur Créer pour générer à nouveau la spécification. Vous verrez le type de sport dans les spécifications mises à jour.

Notez que vous pouvez également revenir à la requête précédente en cliquant sur l'historique des requêtes en haut de la zone de saisie de la requête.

Étape 5: Modifiez les spécifications

Vous pouvez modifier la spécification en cliquant sur Afficher le code et en saisissant vos mises à jour directement dans la spécification. Pour cet exemple, remplacez la description par "API de gestion du contenu d'articles de blog de sport".

Modification de code dans Cloud Code Gemini Code Assist

Étape 6: Testez l'API à l'aide d'un serveur fictif

Testez l'API à l'aide du serveur fictif local, qui émule les réponses pour l'API. Dans la liste déroulante Serveurs, sélectionnez l'option dont le nom contient Serveur de développement local. Une fois la sélection effectuée, ouvrez le chemin d'accès POST et cliquez sur Essayer.

Modifiez les valeurs "author", "content" et "title" dans le corps de la requête pour utiliser vos propres valeurs:

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

Cliquez sur Execute (Exécuter) pour afficher une réponse fictive de l'API dans la section Responses (Réponses).

Étape 7: Enregistrer votre API dans le hub d'API

(Facultatif) Une fois votre API examinée et finalisée, rendez-la disponible pour les développeurs en l'enregistrant avec le hub d'API :

  1. Cliquez sur Enregistrer dans le hub d'API.
  2. Suivez les instructions pour enregistrer l'API. Consultez la page Enregistrer des API pour en savoir plus sur l'enregistrement avec le hub d'API et sur les informations que vous devez fournir.

Cliquez sur Enregistrer pour enregistrer votre nouvelle API avec le nom de votre choix.

Étape 8: Créer un groupe de proxys d'API à partir de cette spécification

Pour créer un groupe de proxys d'API Apigee à partir de cette spécification, cliquez sur Créer un groupe de proxys d'API dans le menu Plus. Une fois le proxy créé, il devrait s'afficher sous apiproxies dans le menu de gauche. Consultez la page Développer des proxys d'API pour en savoir plus sur l'utilisation des proxys d'API dans Cloud Code.
Création d'un groupe de proxys d'API dans Cloud Code Gemini Code Assist

Étapes suivantes