Partager via

Tutoriel : ajouter des environnements et des déploiements pour les API

Ce tutoriel explique comment augmenter l’inventaire dans votre centre d’API en ajoutant des informations sur les environnements et les déploiements d’API.

  • Un environnement représente un emplacement où un runtime d’API peut être déployé, par exemple une plateforme de gestion des API.
  • Un déploiement est un emplacement ou une adresse, où les utilisateurs peuvent accéder à une API.

Pour plus d’informations sur les API, les déploiements et d’autres entités que vous pouvez inventorier dans le Centre des API Azure, consultez les concepts clés.

Ce tutoriel vous montre comment utiliser le Portail pour :

  • Ajouter des informations sur les environnements d’API
  • Ajouter des informations sur les déploiements d’API

Prerequisites

Ajouter un environnement

Utilisez votre centre d’API pour suivre vos environnements d’API réels. Par exemple, vous pouvez utiliser Azure Gestion des API ou une autre solution pour distribuer, sécuriser et surveiller certaines de vos API. Vous pouvez également servir directement certaines API à l’aide d’un service de calcul ou d’un cluster Kubernetes.

Ici, vous ajoutez des informations sur un environnement fictif de gestion des API Azure à votre centre d’API. Si vous préférez, ajoutez des informations sur l’un de vos environnements existants. Configurez vos métadonnées intégrées et toutes les métadonnées personnalisées que vous avez définies dans un didacticiel précédent.

  1. Connectez-vous au portail Azure, puis accédez à votre centre d’API.

  2. Dans le menu de la barre latérale, sous Ressources, sélectionnez Environnements>+ Nouvel environnement.

  3. Dans la page Nouvel environnement, ajoutez les informations suivantes. Si vous avez précédemment défini les métadonnées métier personnalisées ou d’autres métadonnées affectées aux environnements, vous les voyez en bas de la page.

    Réglage Valeur Descriptif
    Titre de l’environnement Entrez Mon test. Nom que vous choisissez pour l’environnement
    Identification Une fois que vous avez entré le titre précédent, le centre d’API Azure génère cet identificateur que vous pouvez remplacer. Nom de la ressource Azure pour l’environnement
    Type d’environnement Sélectionnez Test dans la liste déroulante. Type d’environnement pour les API
    Description Si vous le souhaitez, entrez une description. Description de l’environnement
    Serveur
    Type Si vous le souhaitez, sélectionnez Gestion des API Azure dans la liste déroulante. Type de solution de gestion des API utilisée
    URL du portail de gestion Si vous le souhaitez, entrez une URL pour une interface de gestion, par exemple https://admin.contoso.com URL de l’interface de gestion pour l’environnement
    intégration
    Développement de l’URL du Portail Si vous le souhaitez, entrez une URL pour un portail de développement, par exemple https://developer.contoso.com URL de l’interface pour l’intégration des développeurs dans l’environnement
    Instructions Si vous le souhaitez, sélectionnez Modifier et entrer des instructions d’intégration dans Markdown standard. Instructions d’intégration aux API à partir de l’environnement
    Métier Si vous avez ajouté ces métadonnées personnalisées, effectuez une sélection dans la liste déroulante, par exemple Informatique. Métadonnées personnalisées qui identifient l’unité commerciale qui gère l’environnement

    Capture d’écran montrant l’ajout d’un environnement d’API dans le portail.

  4. Cliquez sur Créer. L’environnement apparaît dans la liste des environnements.

Ajoutez un déploiement

Le centre d’API peut également vous aider à cataloguer vos déploiements d’API, les environnements d’exécution où les API que vous effectuez le suivi sont déployées.

Ici, vous ajoutez un déploiement en associant l’une de vos API à l’environnement que vous avez créé dans la section précédente. Vous configurez les métadonnées intégrées et toutes les métadonnées personnalisées que vous avez définies.

  1. Dans le portail Azure, accédez à votre centre d’API.

  2. Dans le menu de la barre latérale, sous Ressources, sélectionnez API.

  3. Sélectionnez une API, par exemple l’API Conférence.

  4. Dans la page API Conférence, sous Détails, sélectionnez Déploiements>+ Ajouter un déploiement.

  5. Dans la page Ajouter un déploiement, ajoutez les informations suivantes. Si vous avez précédemment défini les métadonnées métier personnalisées ou d’autres métadonnées affectées aux environnements, vous pouvez les voir en bas de la page.

    Réglage Valeur Descriptif
    Titre Entrez Déploiement V1. Nom que vous choisissez pour le déploiement
    Identification Une fois que vous avez entré le titre précédent, le centre d’API Azure génère cet identificateur que vous pouvez remplacer. Nom de la ressource Azure pour le déploiement
    Description Si vous le souhaitez, entrez une description. Description du déploiement
    Environnement Effectuez une sélection dans la liste déroulante, par exemple Mes tests, ou sélectionnez éventuellement Créer un nouveau. Environnement nouveau ou existant dans lequel la version de l’API est déployée
    Définition Sélectionnez ou ajoutez un fichier de définition pour l’API Conférence. Fichier de définition d’API
    URL du Runtime Entrez une URL de base, par exemple https://api.contoso.com. URL du runtime de base pour l’API dans l’environnement
    Métier Si vous avez ajouté ces métadonnées personnalisées, effectuez une sélection dans la liste déroulante, par exemple Informatique. Métadonnées personnalisées qui identifient l’unité commerciale qui gère les API dans l’environnement

    Capture d’écran montrant l’ajout d’un déploiement d’API dans le portail.

  6. Cliquez sur Créer. Le déploiement apparaît dans la liste des déploiements.

Ce tutoriel vous montre comment utiliser le Portail pour :

  • Ajouter des informations sur les environnements d’API
  • Ajouter des informations sur les déploiements d’API

Contenu connexe

  • Last updated on