Concevoir et modifier des API

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

Consultez la documentation d' Apigee Edge.

Cette page explique comment concevoir et modifier des API dans Apigee dans Cloud Code.

Avant de commencer

Avant d'utiliser la fonctionnalité décrite dans ce guide, assurez-vous d'avoir suivi les étapes de configuration de la section Configurer la gestion des API Apigee dans Cloud Code pour VS Code, y compris de vous assurer que votre compte utilisateur dispose des rôles requis listés dans Rôles requis pour utiliser le hub d'API Apigee avec le développement local Apigee.

Concevoir des API

Vous pouvez ajouter et modifier des proxys d'API Apigee et des API du hub d'API directement dans Cloud Code.

  • Créez un proxy d'API Apigee en suivant les étapes décrites dans Créer un proxy d'API.
  • Créez une API du hub d'API en cliquant sur l'icône Plus dans la ligne de l'hôte de votre hub d'API. Une fenêtre de modification des spécifications et un panneau Swagger s'ouvrent pour la nouvelle spécification d'API, ce qui vous permet de publier l'API dans votre hub d'API.

Modifier les API

Vous pouvez modifier les API que vous avez enregistrées localement ou à partir du catalogue de votre hub d'API. Les modifications que vous apportez dans Cloud Code peuvent être publiées dans le hub d'API ou enregistrées en tant que groupe de proxys d'API Apigee.

Quelle que soit la méthode utilisée pour modifier une API, vous pouvez mettre à jour manuellement la spécification ou utiliser le chat Gemini Code Assist (s'il est activé) pour itérer sur la spécification. Notez que lorsque vous utilisez le chat Gemini Code Assist pour itérer sur la spécification, les suggestions de Gemini Code Assist n'incluent pas le contexte d'entreprise de votre hub d'API.

Modifier une spécification d'API à partir du hub d'API

Pour modifier une spécification d'API stockée dans le catalogue de votre hub d'API, suivez les instructions dans cette section. Pour s'intégrer au hub d'API, votre projet Apigee doit être provisionné avec le hub d'API. Consultez la section Avant de commencer.

  1. Assurez-vous que le projet que vous avez sélectionné dans Cloud Code est le projet dont le catalogue du hub d'API contient l'API que vous souhaitez modifier.
  2. Dans le menu de gauche, développez l'arborescence API Hub dans la section Apigee.
  3. Sélectionnez l'API et la version à modifier dans la liste. Le fichier YAML et la vue du panneau Swagger de l'API s'affichent.

Modifier une spécification d'API stockée localement

Pour modifier une spécification d'API stockée localement, ouvrez le fichier dans Cloud Code.

Si vous avez créé un groupe de proxys Apigee à partir de la spécification, vous pouvez ouvrir le fichier du groupe de proxys dans Cloud Code en cliquant sur le nom du proxy d'API sous apiproxies dans votre espace de travail Apigee.

Enregistrer des API en tant que groupes de proxys d'API

Vous pouvez enregistrer votre API en tant que groupe de proxys d'API Apigee afin de pouvoir l'utiliser dans votre environnement de développement local Apigee. Pour en savoir plus sur l'utilisation des proxys d'API dans Cloud Code, consultez Développer des proxys d'API.

  1. Cliquez sur Create API proxy bundle (Créer un groupe de proxys d'API) dans le panneau Swagger.
  2. Dans le champ d'invite, nommez votre proxy d'API et continuez.
  3. Votre proxy d'API s'affiche dans le menu de gauche Apigee de votre espace de travail local, sous apiproxies.

Publier des API dans le hub d'API

Si vous utilisez le hub d'API, vous pouvez mettre vos API à la disposition d'autres développeurs en les enregistrant dans le hub d'API :

  1. Dans le panneau Swagger d'une spécification d'API nouvelle ou modifiée, cliquez sur Publish to API hub (Publier dans le hub d'API).
  2. Dans le formulaire, fournissez des métadonnées pour l'API afin d'améliorer sa détectabilité et l'organisation des API dans le catalogue de votre hub d'API. La plupart des champs sont remplis automatiquement à partir de la spécification d'API, mais vous pouvez modifier les valeurs. Consultez la section Enregistrer une API pour en savoir plus sur l'enregistrement dans le hub d'API et sur les informations que vous devez fournir.
    • Nom à afficher de l'API (obligatoire) : nom de l'API, visible par les autres développeurs.
    • Description de l'API (facultatif) : description de l'API pour référence interne/de développeur référence.
    • Nom du propriétaire de l'API (facultatif) : nom du propriétaire de l'API.
    • Adresse e-mail du propriétaire de l'API (facultatif) : adresse e-mail du propriétaire.
    • Version de l'API (obligatoire) : version de l'API.
    • Étape du cycle de vie (facultatif) : sélectionnez une étape dans la liste.
  3. Cliquez sur Publish (Publier) pour publier l'API dans le hub d'API.
  4. Après un court délai, vos modifications devraient être visibles dans l'arborescence API Hub de la section Apigee de Cloud Code.

Tester des API à l'aide d'un serveur de simulation

Vous pouvez tester votre API à l'aide d'un serveur de simulation local ou d'un serveur de simulation distant basé sur Google Cloud. Le serveur de simulation local est installé et disponible par défaut, tandis que vous devez configurer et gérer Google Cloud les serveurs de simulation.

Utiliser le serveur fictif local

Le serveur local de simulation accepte les requêtes adressées à cette API et émule les réponses. Il n'est utilisable que pendant la session en cours par l'utilisateur actuel. Toutefois, contrairement au serveur de simulation distant, il ne nécessite aucune configuration ni gestion et n'entraîne aucun coût.

De plus, les serveurs de simulation locaux :

Pour utiliser le serveur fictif local:

  1. Sélectionnez le serveur de simulation local dans le menu déroulant Servers (Serveurs) (s'il n'est pas déjà sélectionné) :
    Serveur mock local Cloud Code Gemini Code Assist dans le menu déroulant
  2. Ouvrez un chemin d'accès dans le panneau Swagger, puis cliquez sur Try it out (Essayer).
    Navigation dans les requêtes de Cloud Code Gemini Code Assist
  3. Renseignez tous les paramètres de requête, puis cliquez sur Execute (Exécuter).
    Navigation dans les requêtes de Cloud Code Gemini Code Assist

Utiliser un serveur de simulation distant

Un serveur de simulation distant permet de créer une instance de serveur de simulation persistante qui, contrairement au serveur de simulation local, peut être partagée et utilisée par d'autres membres de votre organisation pour tester la nouvelle API. Les serveurs de simulation distants ne peuvent être utilisés qu'avec des API enregistrées dans le hub d'API.

Les serveurs de simulation distants ne sont pas mis à jour automatiquement pour les modifications que vous apportez à l'API après le déploiement du serveur de simulation. Attendez donc d'ajouter le serveur de simulation jusqu'à ce que vous ayez entièrement créé l'API.

Le déploiement d'un Google Cloud serveur de simulation distant crée un service Cloud Run. Il crée une image de conteneur pour le serveur de simulation à l'aide de Cloud Build et importe l'image de conteneur dans Cloud Artifact Registry dans votre projet Google. Consultez Qu'est-ce que Cloud Run ?, Gérer les services et la documentation Artifact Registry.

Vous pouvez utiliser le compte de service par défaut ou fournir un compte de service plus limité pour déployer l'application Cloud Run. Pour en savoir plus, consultez Gérer les API Cloud et les bibliothèques clientes Cloud dans Cloud Code pour VS Code.

Pour déployer un serveur de simulation distant, procédez comme suit :

  1. Sélectionnez Deploy mock server (Déployer le serveur de simulation) dans le panneau Swagger.
  2. Si votre API n'est pas déjà enregistrée dans le hub d'API, enregistrez-la lorsque vous y êtes invité.
  3. Spécifiez les détails du serveur de simulation distant : Server Name (Nom du serveur), Secure Server (Serveur sécurisé), Service Account (Compte de service) (laissez ce champ vide pour utiliser le compte de service par défaut) et indiquez si vous souhaitez ajouter l'URL du serveur à la spécification d'API. Cliquez sur Create (Créer) pour créer le serveur de simulation distant.
  4. La génération du serveur de simulation distant prend plusieurs minutes. Vous pouvez suivre la progression dans le panneau OUTPUT (SORTIE) de Cloud Code et dans la fenêtre pop-up de notification en bas à droite de votre VS Code.
  5. Une fois le processus de création du serveur de simulation distant terminé, l'URL du serveur distant s'affiche dans la liste des serveurs du panneau Swagger et dans le panneau OUTPUT.
  6. Pour utiliser le serveur de simulation, ouvrez un chemin d'accès, puis cliquez sur Try it out (Essayer).
    Navigation dans les requêtes de Cloud Code Gemini Code Assist

    Renseignez tous les paramètres de requête, puis cliquez sur Exécuter.
    Navigation dans les requêtes de Cloud Code Gemini Code Assist

    Vous pouvez également envoyer des requêtes à l'aide de curl depuis un prompt. Utilisez l'adresse et le port du serveur dans le menu déroulant Serveurs.

Pour partager l'accès au serveur de simulation avec d'autres utilisateurs :

  1. Attribuez aux autres utilisateurs le rôle d'appelant pour le service déployé. Consultez la section Authentifier les développeurs.
  2. Lorsqu'ils envoient la requête au serveur de simulation, les utilisateurs suivent les instructions de la section Tester votre service privé.

Pour gérer les serveurs distants de simulation déployés :

  1. Accédez au hub d'API Apigee.
  2. Recherchez l'API pour afficher tous les déploiements de l'API, y compris les serveurs de simulation distants.
  3. Utilisez l'URL de la ressource pour accéder au déploiement et le gérer en arrêtant, en supprimant et en effectuant d'autres actions sur le serveur de simulation.