Premiers pas avec API Gateway et le hub d'API

Ce tutoriel vous explique comment connecter API Gateway au hub d'API pour publier facilement les métadonnées d'API depuis votre projet API Gateway vers le hub d'API.

Dans ce tutoriel, vous allez utiliser la console Google Cloud .

Liste de tâches

Tout au long du tutoriel, reportez-vous à la liste de tâches présentée ci-dessous. Toutes les tâches sont nécessaires pour connecter API Gateway au hub d'API.

1. Suivez les étapes préalables décrites dans Avant de commencer.

2. Déployez une API sur API Gateway.

3. Associez votre projet API Gateway au hub d'API.

4. Affichez votre API API Gateway dans le hub d'API.

5. Faites le nécessaire pour éviter que des frais ne soient facturés sur votre compte Google Cloud. Consultez la section Effectuer un nettoyage.

Avant de commencer

Avant de commencer, assurez-vous d'avoir effectué les étapes préalables suivantes :

1. Configurez API Gateway dans votre projet.

2. Configurez le hub d'API dans votre projet hôte.

Configurer API Gateway dans votre projet

Pour configurer API Gateway dans votre projet, procédez comme suit :

1. Dans la console Google Cloud , accédez à la page API Gateway.

   Accéder à API Gateway

   Remarque : Si vous ne prévoyez pas de conserver les ressources créées dans ce tutoriel, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

2. API Gateway nécessite l'activation des services Google suivants :

   Nom	Titre
   apigateway.googleapis.com	API de la passerelle API
   servicemanagement.googleapis.com	API Service Management
   servicecontrol.googleapis.com	API Service Control

   Si vous n'avez pas encore activé ces services pour le projet que vous sélectionnez, vous êtes invité à le faire.

3. Vérifiez que la facturation est activée sur votre projet.

   Découvrir comment activer la facturation

Configurer le hub d'API dans votre projet hôte

1. Créez ou sélectionnez un projet Google Cloud à utiliser comme projet hôte.

   Un projet hôte est un projet Google Cloud de votre organisation Google Cloud que vous désignez comme projet client pour toutes les ressources du hub d'API. Une seule instance de hub d'API peut être provisionnée par projet hôte.

   Pour permettre la découverte centralisée des API dans tous vos API Gateways, nous vous recommandons d'utiliser un projet hôte dédié pour l'instance de hub d'API et d'associer plusieurs projets API Gateway, appelés projets d'exécution, à l'instance de hub d'API.

   Si une instance de hub d'API est déjà provisionnée dans votre organisation ou votre dossier Google Cloud , nous vous recommandons d'ignorer cette étape et d'associer votre projet API Gateway à l'instance de hub d'API existante.

2. Attribuez les rôles IAM (Identity and Access Management) requis pour connecter API Gateway au hub d'API.

3. Provisionnez le hub d'API dans votre projet hôte.

Déployer une API sur API Gateway

Suivez le guide de démarrage rapide d'API Gateway pour déployer un service Cloud Run "Hello World" et créer une passerelle pointant vers ce service.

Par exemple, l'API helloworld est déployée sur la passerelle API helloworld-gateway, comme indiqué sur la page "Passerelles" de la console Google Cloud .

Associer votre projet API Gateway au hub d'API

Pour associer votre projet API Gateway au hub d'API, procédez comme suit :

1. Dans la console Google Cloud , accédez à la page API Hub.

   Accéder à l'API Hub

2. Sélectionnez votre projet hôte API Hub dans le menu déroulant.
3. Cliquez sur Paramètres dans le menu de navigation de gauche pour ouvrir la page Paramètres.
4. Accédez à l'onglet Associations de projets.
5. Cliquez sur Associer le projet d'exécution.
   Le volet Sélectionner une ressource s'affiche.
6. Cliquez sur le projet Google Cloud dans lequel API Gateway est provisionné.
7. Dans le volet Paramètres d'association de projet, sélectionnez API Gateway et tous les autres composants d'API que vous souhaitez importer automatiquement.
8. Cliquez sur Enregistrer.

Votre projet d'exécution est associé et affiché dans la liste des projets d'exécution associés de la console Google Cloud .

Exemple :

Pour activer l'ingestion de données en temps réel, le hub d'API crée une instance de plug-in API Gateway pour le projet d'exécution associé lorsque vous sélectionnez l'importation des composants API Gateway. Vous pouvez afficher cette instance de plug-in dans la colonne Plug-ins associés de la page Associations de projets.

Afficher votre API API Gateway dans le hub d'API

Pour afficher votre API API Gateway dans le hub d'API, procédez comme suit :

1. Dans la console Google Cloud , accédez à la page API du hub d'API.

   Accéder à l'API Hub

2. Localisez l'API "Hello World" que vous avez déployée sur API Gateway.

   Si nécessaire, sélectionnez Passerelle : API Gateway dans le menu déroulant Filtrer pour n'afficher que les API API Gateway.

   Exemple :

   

3. Cliquez sur l'API pour afficher plus de détails, y compris les métadonnées de l'API.

Effectuer un nettoyage

Pour éviter que les ressources utilisées dans ce tutoriel ne soient facturées sur votre compte Google Cloud , vous pouvez :

• Supprimer votre passerelle
• Supprimer votre API

Vous pouvez également supprimer les projets Google Cloud utilisés pour ce tutoriel.

Étapes suivantes

• En savoir plus sur API Gateway
• Découvrez comment centraliser vos API à l'aide du hub d'API.