Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'
Apigee Edge.
Cette page fournit les instructions permettant de créer un environnement de développement local Apigee API Management dans Cloud Code pour VS Code. Pour en savoir plus sur les fonctionnalités de l'environnement de développement local, consultez Présentation du développement local avec Apigee.
Le processus de configuration nécessite de suivre les deux sections suivantes de ce guide :
En fonction de vos cas d'utilisation, suivez également Configurer le développement de proxys d'API pour le développement local Apigee.
Avant de commencer
Pour configurer et utiliser Apigee dans VS Code, voici les éléments dont vous avez besoin :
- Un projet Google Cloud pour vous connecter à votre environnement de développement local. Le projet doit être provisionné pour Apigee afin de créer un espace de travail local Apigee dans lequel vous pouvez développer et tester des proxys d'API.
- (Recommandé) Le hub d'API provisionné sur votre projet. Le hub d'API est nécessaire pour créer un
serveur de simulation distant afin de tester les spécifications d'API.
Si vous ne souhaitez pas ajouter le hub d'API à votre projet, vous pouvez associer le projet à un autre projet pour lequel le hub d'API est activé. Pour savoir comment associer un projet à un hub d'API, consultez Associer un projet d'exécution à un hub d'API. - Les rôles requis pour utiliser le hub d'API avec le développement local Apigee pour les actions que vous prévoyez d'effectuer.
- Vous devez être familiarisé avec VS Code, savoir comment le gérer et comment effectuer des actions courantes telles que l'accès aux paramètres et l'installation d'extensions. Consultez la documentation VS Code.
Installer VS Code et l'extension Cloud Code
Cette section fournit les instructions d'installation de VS Code et de l'extension Cloud Code dans VS Code. Il s'agit de la première étape de la configuration du développement local pour Apigee. Elle est requise pour utiliser n'importe laquelle des fonctionnalités de développement local d'Apigee.
Pour installer VS Code et l'extension Cloud Code, procédez comme suit :
- Si ce n'est pas déjà fait, téléchargez et installez Visual Studio Code (VS Code) sur votre ordinateur local.
- Installez l'extension Cloud Code, comme décrit dans Installer l'extension Cloud Code. Si vous prévoyez de gérer des proxys d'API dans votre environnement local, installez Docker pendant le processus.
- (Recommandé) Activez les mises à jour automatiques pour l'extension Cloud Code. Dans Paramètres, recherchez Extensions : Mise à jour automatique et activez ce paramètre pour toutes les extensions ou pour l'extension Cloud Code de façon individuelle.
- Redémarrez VS Code.
Rôles requis pour utiliser le hub d'API Apigee avec le développement local Apigee
Vous aurez besoin des rôles listés ci-dessous pour effectuer les étapes de conception et de test d'API à l'aide du hub d'API Apigee :
| Tâche | Rôles requis |
|---|---|
| Afficher et modifier les API du hub d'API | Éditeur ou administrateur Cloud API Hub |
| Publier des API dans le hub d'API | Éditeur ou administrateur Cloud API Hub |
| Configurer et gérer un serveur de simulation distant pour tester les API | Administrateur Artifact Registry Compte de service Cloud Build Administrateur Cloud Run Administrateur Service Usage Consultez la documentation de référence sur les rôles de base et prédéfinis d'IAM. Vous devez également avoir installé la gcloud CLI. |
Configurer le développement de proxy d'API pour le développement local Apigee
Suivez les étapes de cette section si vous souhaitez utiliser votre environnement de développement local pour développer et tester des proxys d'API Apigee. Suivez également ces étapes pour pouvoir créer un proxy d'API à partir d'une spécification OpenAPI.
- Créez un espace de travail Apigee.
- Installez l'émulateur Apigee.
- Ajoutez un conteneur pour effectuer le déploiement sur l'émulateur Apigee.
Étapes suivantes
Une fois l'installation et la configuration terminées, commencez à utiliser Cloud Code :
- Accéder à la gestion des API dans Cloud Code et explorer
- Créer et déployer votre premier proxy d'API (développement local)