Exercice - Créer une passerelle API

  • 10 minutes

Dans cet exercice, vous déployez un exemple d’API web et vous configurez une passerelle API. Dans une prochaine unité, vous publiez l’API web sur votre passerelle.

Dans l’exemple d’entreprise de vente de chaussures, NorthWind Shoes a décidé de partager une API de stock avec des partenaires. Cette API permet aux partenaires d’accéder aux informations sur les stocks et les produits.

Important

Vous avez besoin de votre propre abonnement Azure pour exécuter cet exercice et des frais pourraient vous être facturés. Si vous n’avez pas d’abonnement Azure, créez un compte gratuit avant de commencer.

Déployer l’API web de l’entreprise de ventes de chaussures

Vous avez développé une application .NET Core qui génère des informations sur les stocks et sur les produits. L’application inclut Swashbuckle pour générer la documentation Swagger OpenAPI.

Pour gagner du temps, nous allons commencer en exécutant un script pour héberger notre API RESTful dans Azure. Le script effectue les étapes suivantes :

  • Il crée un plan Azure App Service dans le niveau gratuit.
  • Crée une API web dans une instance Azure App Service, configurée pour le déploiement Git à partir d’un dépôt local.
  • Définit les informations d’identification de déploiement au niveau du compte pour l’application.
  • Il configure Git localement.
  • Déploie notre API web sur l’instance App Service.

  1. Connectez-vous au portail Azure.

  2. Dans la barre des tâches Azure, sélectionnez l’icône Cloud Shell pour ouvrir Azure Cloud Shell.

    Capture d’écran de l’icône Cloud Shell dans la barre des tâches.

  3. Exécutez la commande git suivante dans Cloud Shell pour cloner le référentiel GitHub et télécharger le code source de notre application.

    git clone https://github.com/MicrosoftDocs/mslearn-publish-manage-apis-with-azure-api-management.git

  4. Une fois l’opération terminée, ouvrez le dossier de votre référentiel local et listez son contenu en exécutant les commandes suivantes.

    cd mslearn-publish-manage-apis-with-azure-api-management
ls -l

    Un des fichiers est setup.sh. Comme son nom l’indique, il s’agit du script que nous exécutons pour configurer notre API de test.

  5. Exécutez ce script en entrant la commande suivante. Il génère une application web publique qui expose une interface OpenAPI.

    bash setup.sh

    L’exécution du script dure environ une minute. Pendant le déploiement, toutes les dépendances nécessaires à l’exécution de l’application sont automatiquement installées sur l’instance App Service distante. La sortie liste toutes les opérations. Une fois le script terminé, les deux dernières lignes sont des URL que vous utilisez pour tester le déploiement de l’application.

  6. Pour vérifier que l’application a été déployée correctement, copiez la première URL (URL Swagger) à partir de Cloud Shell et collez-la dans un nouvel onglet de votre navigateur.

    Le navigateur doit présenter l’interface utilisateur Swagger pour notre application, et déclarer les points de terminaison RESTful suivants :

    • api/inventory génère une liste de produits et la quantité en stock.
    • api/inventory/{productid} renvoie la quantité en stock pour l’ID produit spécifié (un entier).
    • api/Products génère une liste de produits.
    • api/Products/{productid} renvoie les détails de l’ID produit spécifié.

    Vue d’ensemble de la Gestion des API.

  7. Enfin, copiez la deuxième URL (URL JSON Swagger) à partir de la sortie Cloud Shell et enregistrez-la dans un éditeur de type Bloc-notes. Vous avez besoin de cette URL dans l’exercice suivant.

Déployer une passerelle API

La dernière tâche de cet exercice consiste à créer une passerelle API dans le portail Azure. Dans l’exercice suivant, vous utilisez cette passerelle pour publier votre API.

  1. Connectez-vous au portail Azure.

  2. Dans Services Azure, ou dans la page Accueil, sélectionnez Créer une ressource. Le volet Créer une ressource apparaît.

  3. Dans le menu de ressource, sélectionnez Intégration puis, dans les résultats, sélectionnez Gestion des API. Un volet Créer un service Gestion des API s’affiche.

  4. Sous l’onglet Informations de base, entrez les valeurs suivantes pour chaque paramètre.

    Paramètre Valeur
    Détails du projet
    Abonnement Sélectionnez votre abonnement.
    Resource group Sélectionnez un nouveau groupe de ressources ou un groupe existant. Un groupe de ressources est un conteneur logique qui contient les ressources associées d’une solution Azure.
    Détails de l’instance
    Région Sélectionnez une région disponible.
    Nom de la ressource apim-NorthWindShoes<random number>, en remplaçant random number par votre propre série de nombres pour garantir que le nom est globalement unique.
    Nom de l’organisation NorthWindShoes. Nom de votre organisation à utiliser sur le portail des développeurs et pour les notifications par e-mails. (Le portail des développeurs et les notifications ne sont pas disponibles dans tous les niveaux de service.)
    E-mail de l’administrateur Adresse e-mail recevant toutes les notifications système.
    Niveau de tarification Consumption

    Notes

    Le niveau Consommation offre un déploiement rapide à des fins de test et présente un modèle tarifaire de paiement à l’utilisation. L’expérience de gestion des API globale est similaire à celles des autres niveaux tarifaires.

  5. Sélectionnez Vérifier + créer pour valider vos paramètres.

  6. Une fois la validation réussie, sélectionnez Créer. Le déploiement peut prendre plusieurs minutes.

  7. Une fois le déploiement terminé, votre instance Gestion des API est listée dans les ressources Azure. Sélectionnez Accéder à la ressource pour voir le volet correspondant à votre service Gestion des API.