Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.
Pour pouvoir développer vos API localement à l'aide d'Apigee dans Visual Code (VS Code), vous devez créer un espace de travail Apigee dans Apigee en VS Code ou en ouvrir un existant. Un espace de travail Apigee contient la structure de répertoires requise pour le développement local.
Les sections suivantes décrivent comment créer, ouvrir et gérer un espace de travail Apigee.
Créer un espace de travail Apigee
Pour créer un espace de travail Apigee :
Effectuez l'une des actions suivantes :
Cliquez sur Créer un espace de travail Apigee dans la section Apigee si aucun espace de travail Apigee n'est actuellement ouvert.
Placez le curseur dans la barre de titre d'Apigee, cliquez sur , puis sélectionnez Créer un espace de travail Apigee dans le menu déroulant.
Cliquez sur Afficher > Palette de commandes pour ouvrir la palette de commandes, puis sélectionnez Cloud Code : Créer un espace de travail Apigee.
Saisissez un nom pour l'espace de travail Apigee.
Accédez au répertoire dans lequel vous souhaitez enregistrer l'espace de travail Apigee.
Si vous utilisez la gestion du contrôle de code source, sélectionnez un emplacement dans le dépôt source.Cliquez sur Sélectionner le dossier de l'espace de travail.
L'espace de travail Apigee est créé, stocké dans le répertoire local spécifié et ouvert dans l'explorateur VS Code.Cliquez sur l'icône Cloud Code
dans la barre des tâches.
L'espace de travail Apigee s'affiche dans la section Apigee, comme illustré ci-dessous.
Comme indiqué, un ensemble de dossiers est créé pour vous permettre de développer des proxys d'API et des flux partagés, de configurer et de déployer des environnements, ainsi que de créer et d'exporter des ressources de test. Pour plus d'informations, consultez la section Comprendre la structure d'un espace de travail Apigee.
Ouvrir un espace de travail Apigee
Pour ouvrir un espace de travail Apigee existant :
Effectuez l'une des actions suivantes :
Cliquez sur Open Apigee workspace (Ouvrir l'espace de travail Apigee) dans l'explorateur Apigee si aucun espace de travail Apigee n'est actuellement ouvert.
Placez le curseur dans la barre de titre Apigee Explorer, cliquez sur , puis sélectionnez Open Apigee workspace (Ouvrir l'espace de travail Apigee) dans le menu déroulant.
Sélectionnez Afficher > Palette de commandes pour ouvrir la palette de commandes, puis sélectionnez Cloud Code : Ouvrir l'espace de travail Apigee.
Accédez à l'espace de travail Apigee dans votre environnement local.
Sélectionnez le dossier de premier niveau de votre espace de travail Apigee qui contient le dossiersrc/main/apigee.Cliquez sur Sélectionner le dossier de l'espace de travail.
L'espace de travail Apigee est ouvert dans l'explorateur VS Code à l'adresseyour-workspace-folder/src/main/apigee.Cliquez sur l'icône Cloud Code
dans la barre des tâches.
L'espace de travail Apigee s'affiche dans Apigee Explorer, comme illustré ci-dessous.
Comme indiqué, un ensemble de dossiers est créé pour vous permettre de développer des proxys d'API et des flux partagés, de configurer des environnements de déploiement et de créer des ressources de test. Pour en savoir plus sur sa structure, consultez la page Comprendre la structure d'un espace de travail Apigee.
Comprendre la structure d'un espace de travail Apigee
Lorsque vous créez un espace de travail Apigee dans Apigee VS Code, un ensemble de dossiers est créé pour vous permettre de développer des proxys d'API et des flux partagés, de configurer et de déployer des environnements, ainsi que de créer et d'exporter des ressources de test. L'espace de travail Apigee est stocké dans your-workspace-folder/src/main/apigee dans votre environnement local.
Le tableau suivant récapitule la structure générale des espaces de travail Apigee.
| Dossier | Description |
|---|---|
apiproxies
|
Il contient un dossier apiproxy-name/apiproxy distinct pour chaque configuration de proxy d'API, structuré conformément à la structure du répertoire de configuration du proxy API.
Par exemple : Pour en savoir plus, consultez la section Développer des proxys d'API. |
environments
|
Définit les contextes d'exécution pour les proxys d'API et les flux partagés que vous souhaitez déployer, y compris :
Pour en savoir plus, consultez la page Configurer et déployer des environnements. |
sharedflows
|
Il contient un dossier sharedflow-name/sharedflowbundle distinct pour chaque configuration de flux partagé, structuré comme décrit dans la documentation de référence sur la configuration des groupes de flux partagés.
Par exemple : Pour en savoir plus, consultez la section Développer des flux partagés. |
tests
|
Fournit un ensemble de ressources de test, telles que des produits API ou des développeurs, nécessaires pour tester vos API localement.
Pour en savoir plus, consultez la section Créer et exporter des ressources de test. |
Vous trouverez ci-dessous un exemple de structure d'un espace de travail Apigee dans votre environnement local, où src/main/apigee est la racine.
Gérer les dossiers et les fichiers dans un espace de travail Apigee
Les sections suivantes décrivent comment gérer des dossiers et des fichiers dans un espace de travail Apigee.
Modifier des fichiers dans un espace de travail Apigee
Pour modifier un fichier dans un espace de travail Apigee, procédez comme suit :
Cliquez sur le nom du fichier que vous souhaitez modifier dans l'explorateur Apigee. Le contenu s'affiche dans l'éditeur.
Modifiez le fichier selon vos besoins.
Sélectionnez File > Save (Fichier > Enregistrer) ou ⌘S pour enregistrer vos modifications.
Copier des dossiers et des fichiers dans un espace de travail Apigee
Pour copier un dossier ou un fichier dans un espace de travail Apigee, procédez comme suit :
Effectuez un clic droit sur le dossier ou le fichier que vous souhaitez copier dans l'explorateur Apigee, puis sélectionnez Copier.
Saisissez un nom unique pour le dossier ou le fichier et appuyez sur Entrée.
Le dossier ou le fichier copié s'affiche dans l'espace de travail Apigee.
Renommer des dossiers et des fichiers dans un espace de travail Apigee
Pour renommer un dossier ou un fichier dans un espace de travail Apigee, procédez comme suit :
Effectuez un clic droit sur le dossier ou le fichier que vous souhaitez copier dans l'explorateur Apigee, puis sélectionnez Rename (Renommer).
Saisissez un nom unique pour le dossier ou le fichier et appuyez sur Entrée.
Le dossier ou le fichier est renommé dans Apigee Explorer.
Supprimer des dossiers et des fichiers d'un espace de travail Apigee
Pour supprimer un dossier ou un fichier d'un espace de travail Apigee, cliquez avec le bouton droit sur le dossier ou le fichier que vous souhaitez copier dans l'explorateur Apigee, puis sélectionnez Supprimer. Le dossier ou le fichier est supprimé de l'espace de travail Apigee.
Actualiser l'affichage de l'espace de travail Apigee
Pour actualiser l'affichage de l'espace de travail Apigee et synchroniser les modifications récentes (éventuellement en dehors d'Apigee dans VS Code), effectuez l'une des actions suivantes :
Placez le curseur sur la barre de titre Apigee Explorer, puis cliquez sur
.Sélectionnez Afficher > Palette de commandes pour ouvrir la palette de commandes, puis sélectionnez Cloud Code : Actualiser la vue Apigee Explorer.
Étapes suivantes
- Commencez à développer vos proxys d'API et vos flux partagés.