Partager via

Migrer le portail d’API avec le plan Entreprise Azure Spring Apps vers Gestion des API Azure

  • Article

Remarque

Les plans Essentiel, Standard et Entreprise seront déconseillés à compter de la mi-mars 2025, avec une période de mise hors service de 3 ans. Nous vous recommandons de passer à Azure Container Apps. Pour plus d’informations, consultez l’annonce de mise hors service d’Azure Spring Apps.

Le plan de consommation standard et dédiée sera déconseillé à compter du 30 septembre 2024, avec un arrêt complet après six mois. Nous vous recommandons de passer à Azure Container Apps. Pour plus d’informations, consultez Migrer le plan de consommation standard et dédiée Azure Spring Apps vers Azure Container Apps.

Cet article s’applique à : ❎ Essentiel/Standard ✅ Entreprise

Cet article décrit comment migrer le portail d’API vers Gestion des API Azure.

Gestion des API Azure fournit une interface centralisée pour afficher les définitions d’API et tester des itinéraires d’API spécifiques directement à partir du navigateur. Cela prend également en charge l’authentification unique (SSO) pour améliorer la sécurité et assurer un accès fluide. La migration à partir du portail d’API avec Azure Spring Apps vers Gestion des API Azure améliore la scalabilité, la sécurité et l’intégration à d’autres services Azure.

Prérequis

Création d'une instance Gestion des API

Utilisez les étapes suivantes pour créer une instance de Gestion des API :

  1. Dans le portail Azure, recherchez Gestion des API dans la barre de recherche.

  2. Sélectionnez Services de Gestion des API dans les résultats, puis Créer.

  3. Fournissez les informations requises suivantes :

    • Abonnement : sélectionnez l’abonnement Azure pour votre service.
    • Groupe de ressources : sélectionnez un groupe de ressources existant ou sélectionnez Créer un nouveau pour en créer un nouveau.
    • Région : choisissez l’emplacement ou la région de votre instance Gestion des API.
    • Nom de ressource : fournissez un nom global unique pour l’instance Gestion des API.
    • Nom de l’organisation : précisez le nom de votre organisation.
    • Adresse e-mail administrateur : indiquez une adresse e-mail utilisée pour les notifications liées à l’instance Gestion des API.

  4. Choisissez le niveau tarifaire en fonction de vos cas d'utilisation. Vous pouvez toujours mettre à jour ou modifier le niveau tarifaire ultérieurement.

  5. Configurez des paramètres facultatifs tels que la surveillance et les paramètres de réseau virtuel.

  6. Sélectionnez Vérifier + créer pour vérifier les paramètres et valider la configuration.

  7. Une fois la validation terminée, sélectionnez Créer. Le déploiement peut prendre 30 à 40 minutes.

  8. Une fois le déploiement terminé, accédez à la page du service gestion des API pour afficher le service nouvellement créé.

Importer des API exposées dans Gestion des API

Il existe deux options pour importer des API dans Gestion des API : ajouter manuellement des API ou importer un fichier de spécification d’API.

Ajouter manuellement des API

Utilisez les étapes suivantes pour ajouter manuellement des API :

  1. Accédez à l’instance Gestion des API dans le portail Azure. Sous la section API, sélectionnez Ajouter une API.

  2. Dans le volet Définir une nouvelle API, sélectionnez l’option HTTP pour définir manuellement une API HTTP.

  3. Fournissez les valeurs de l’API informations de base suivante, puis sélectionnez Créer pour enregistrer :

    • Nom d’affichage : entrez un nom pour votre API.
    • Nom : entrez un identificateur unique pour cette API.
    • URL du service web : précisez l’URL de base de votre API back-end de vos Container Apps.
    • Suffixe d’URL de l’API : définissez le suffixe de cette API. Par exemple : /api/customers-service.

  4. Pour créer des points de terminaison d’API, sélectionnez Ajouter une opération, puis procédez comme suit :

    1. Fournissez les informations générales. Entrez le nom d’affichage et le nom.
    2. Fournissez les détails de l’opération, tels que le verbe HTTP - GET, POST, etc. - URL, paramètres de requête, requête et réponse.
    3. Après avoir ajouté toutes les opérations, enregistrez votre API.

  5. Sélectionnez les noms des API ajoutées. Vous pouvez voir toutes les opérations ajoutées dans l’onglet Conception.

Importer une API de fichier de spécification

Si vous disposez d’une spécification OpenAPI (une définition Swagger) de vos API, vous pouvez importer directement dans Gestion des API en procédant comme suit :

  1. Accédez à l’instance Gestion des API dans le portail Azure.

  2. Ouvrez la section API sous API.

  3. Sélectionnez Ajouter API.

  4. Pour Créer à partir d’une définition, choisissez l’option OpenAPI, qui crée une interface standard de langage non spécifié aux API REST.

  5. Procédez comme suit pour créer une API à partir d’une spécification OpenAPI :

    1. Si vous disposez d’un fichier de spécifications d’API local, sélectionnez Sélectionner un fichier pour charger le fichier. Vous pouvez également fournir une URL accessible publiquement à la spécification OpenAPI.
    2. Vous pouvez affiner davantage les paramètres d’API en fournissant des valeurs pour nom complet, nomet suffixe d’URL de l’API pour les API.
    3. Sélectionnez Créer pour enregistrer les configurations.

  6. Sélectionnez le nom des API ajoutées. Vous pouvez voir toutes les opérations ajoutées dans l’onglet Conception.

Essayer des API dans Gestion des API

Gestion des API Azure fournit une console de test intégrée dans le portail Azure, ce qui facilite l’interaction avec vos API sans avoir besoin d’outils externes. Utilisez les étapes suivantes pour tester votre application :

  1. Accédez à l’instance Gestion des API dans le portail Azure.

  2. Dans la section API, sélectionnez l’API que vous souhaitez tester dans la liste.

  3. Choisissez une opération. Dans la page de présentation de l’API, vous pouvez voir une liste des opérations disponibles (points de terminaison). Cliquez sur l’opération que vous souhaitez tester.

  4. Sélectionnez l’onglet Test pour l’ouvrir dans le portail Azure.

  5. Configurer les paramètres de la requête. Entrez les paramètres nécessaires pour la requête, tels que paramètres de chemin d’accès, paramètres de requête, en-têtes ou corps, en fonction de la méthode d’API. Si une API nécessite : Authorization Token, veillez à l’inclure dans l’en-tête.

  6. Envoyez la demande. Après avoir fourni les détails de la demande, sélectionnez Envoyer. La réponse de l’API s’affiche directement dans le portail Azure, y compris le code de réponse, le corps de la réponseet les en-têtes.

  7. Examinez la réponse. Passez en revue les données de réponse, les codes d’état et les messages d’erreur susceptibles d’indiquer des problèmes liés à l’API ou à la demande.

Migrer l’authentification unique vers Gestion des API

Si vous activez l’authentification unique (SSO) dans le portail d’API et que vous souhaitez également authentifier les demandes auprès de Gestion des API, procédez comme suit pour configurer l’identité dans Gestion des API :

  1. Dans le portail Azure, accédez à votre instance de gestion des API.

  2. Accédez au portail des développeurs>identités.

  3. Sélectionnez Ajouter, puis Azure Active Directory.

  4. Remplissez les champs obligatoires :

    • ID client : l’application ou l’ID client de votre application inscrite dans Microsoft Entra ID.
    • Client secret : le secret de l’application Microsoft Entra ID.
    • Locataire de connexion : le nom de domaine de votre locataire Microsoft Entra ID, tel que yourcompany.onmicrosoft.com
    • URL de redirection : généralement https://{your-apim-instance}.developer.azure-api.net/signin.

  5. Sélectionnez Ajouter pour enregistrer le fournisseur d’identité.

Vous devez ajouter l’URL de redirection à la liste des URL de redirection autorisées de votre application cliente Microsoft Entra ID avant d’enregistrer le nouveau fournisseur d’identité ajouté.

Pour d’autres configurations sur la gestion des API, consultez la documentation Gestion des API.