Tutoriel : Définir des métadonnées personnalisées

Ce tutoriel explique comment définir des métadonnées personnalisées pour vous aider à organiser vos API et d’autres informations dans votre centre d’API. Vous pouvez utiliser des métadonnées personnalisées et intégrées pour rechercher et filtrer et appliquer des normes de gouvernance dans votre organisation.

Pour plus d’informations sur les métadonnées dans le Centre des API Azure, consultez :

• Concepts clés - Métadonnées
• Utiliser des métadonnées pour la gouvernance des API

Dans ce tutoriel, vous allez apprendre à utiliser le portail Azure pour :

• Définir des métadonnées personnalisées dans votre centre d’API
• Afficher le schéma de métadonnées

Prerequisites

• Un Centre d’API dans votre abonnement Azure. Pour en créer un, consultez Démarrage rapide : Créer votre centre d’API.

Définir des métadonnées

Ici, vous définissez deux exemples de métadonnées personnalisées : métier et public ; si vous préférez, définissez d’autres métadonnées de votre choix. Lorsque vous ajoutez ou mettez à jour des API et d’autres informations dans votre inventaire, définissez des valeurs pour les métadonnées personnalisées et toutes les métadonnées intégrées courantes.

Important

N’incluez pas d’informations sensibles, confidentielles ou personnelles dans les titres (noms) des métadonnées que vous définissez. Ces titres sont visibles dans les journaux d’activité de supervision utilisés par Microsoft pour améliorer les fonctionnalités du service. Toutefois, les autres détails et valeurs de métadonnées sont vos données client protégées.

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 Métadonnées>+ Nouvelles métadonnées.

3. Sous l’onglet Détails , entrez des informations sur les métadonnées.

   1. Pour Titre, entrez ligne de métier.

   2. Entrez éventuellement une Description.

   3. Sélectionnez les choix prédéfinis et entrez des choix tels que Marketing, Finance, IT, Sales, etc. Si vous le souhaitez, activez autoriser la sélection de plusieurs valeurs. Cliquez sur Suivant.

   

4. Sous l’onglet Affectations , sélectionnez Obligatoire pour les API. Sélectionnez Facultatif pour les déploiements et les environnements. Vous pouvez ajouter ces entités dans des didacticiels ultérieurs. Cliquez sur Suivant.

   

5. Sous l’onglet Vérifier + créer , passez en revue les paramètres, puis sélectionnez Créer.

   Les métadonnées sont ajoutées à la liste dans la page Métadonnées .

6. Sélectionnez + Nouvelles métadonnées pour ajouter un autre exemple.

7. Sous l’onglet Détails , entrez des informations sur les métadonnées.

   1. Pour Titre, entrez Visible au public.

   2. Sélectionnez type Boolean.

8. Sous l’onglet Affectations , sélectionnez Obligatoire pour les API. Sélectionnez Non applicable pour les déploiements et les environnements.

9. Sous l’onglet Vérifier + créer , passez en revue les paramètres, puis sélectionnez Créer.

   Les métadonnées sont ajoutées à la liste.

Afficher le schéma des métadonnées

Vous pouvez afficher et télécharger le schéma JSON pour les métadonnées définies dans votre centre d’API. Le schéma inclut des métadonnées intégrées et personnalisées.

1. Dans le menu de gauche, sous Ressources, sélectionnez Métadonnées>Afficher le schéma des métadonnées.

2. Sélectionnez Voir le schéma de métadonnées>APIs pour voir le schéma de métadonnées des API, qui inclut des métadonnées intégrées et personnalisées. Vous pouvez également afficher le schéma de métadonnées défini pour les déploiements et les environnements dans votre centre d’API.

   

Étape suivante

Ajoutez des API à l’inventaire dans votre centre d’API.

Inscrire des API dans votre centre d’API