Identification et correction des données d’API manquantes dans Aperçus des API

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 4 minutes de lecture

    • Identifiez et corrigez les données d’API manquantes dans l’espace de travail en liant les éléments manquants et en vérifiant les enregistrements d’API Aperçus des API complets.

    L’absence de métadonnées peut réduire l’efficacité de la découverte d’API, le suivi du cycle de vie et la responsabilité de la propriété. Les éléments manquants courants comprennent :

    • Contexte professionnel
    • Groupe de propriété
    • Modèle de produit
    • Détails de conception

    La résolution des données manquantes garantit une vue plus complète et plus précise des dépendances et de l’appropriation, améliorant ainsi les évaluations de l’impact et la gestion des services.

    L’onglet Vue d’ensemble de l’espace Aperçus des API de travail permet d’améliorer la convivialité, la gouvernance et l’intégration des API en mettant en évidence toutes les données incomplètes ou manquantes dans le Base de données de gestion des configurations (CMDB).

    Rattrapage des données d’API manquantes par rôles

    Les rôles suivants peuvent identifier et résoudre les métadonnées manquantes dans l’API :

    • Un architecte d’entreprise disposant du rôle sn_api_insights_ws.api_mgmt_architect peut accéder à l’onglet Vue d’ensemble de l’espace de travail pour corriger les informations d’API manquantes à l’aide Aperçus des API de tuiles dédiées pour chaque type de données manquantes.
    • Un administrateur CMDB disposant du rôle sn_cmdb_admin peut accéder à l’onglet Vue d’ensemble de l’espace de Aperçus des API travail et sélectionner une barre dans l’histogramme des attributs manquants d’API pour identifier et mettre à jour les métadonnées manquantes.

    Mesures clés de surveillance

    Vous pouvez surveiller les données manquantes suivantes associées aux API au sein de votre organisation :
    Contexte professionnel manquant
    Les API qui ne sont associées à aucun contexte d’entreprise réduisent la clarté et la gouvernance des domaines d’activité qui les fournissent.
    Groupes de propriété manquants
    Les API sans groupe de propriété affecté affectent la gouvernance. L’affectation de groupes de propriété rationalise le suivi des rattrapages, la gestion des accès et la résolution rapide des problèmes.
    Modèles de produit manquant
    Les API sans modèle de produit affecté limitent la capacité à fournir des rapports et des interactions précis avec des API versionnées.
    Conception manquante
    Les API sans représentation de conception entravent leur intégration complète dans le système. La liaison de ces API à leurs équivalents au moment de la conception (tels que les enregistrements d’interfaces numériques) améliore la convivialité et l’efficacité opérationnelle.

    Résolution des données d’API manquantes

    Vous pouvez résoudre les données d’API manquantes en créant des relations pour le contexte professionnel ou des références pour les groupes de propriété, les modèles de produits ou les conceptions, afin d’établir des connexions entre l’API et d’autres CI au sein de .CMDB

    Vous pouvez établir les relations ou références suivantes pour Aperçus des API résoudre les données d’API manquantes :

    Relation entre l’API et le contexte d’entreprise
    Lie une API à un contexte professionnel spécifique, en définissant le contexte dans lequel l’API est utilisée et en créant un enregistrement de relation dans le CMDB.
    Référence du groupe de propriété de l’API
    Lie une API à un groupe responsable de sa gouvernance, de son contrôle d’accès et de sa maintenance, servant de référence sans créer d’enregistrement dans le CMDB.
    Référence du modèle API vers produit
    Relie une API à un modèle de produit, en fournissant des informations sur la gestion des versions, la gamme de produits et l’étape du cycle de vie de l’API, servant de référence sans créer d’enregistrement dans le CMDB.
    API pour référence de conception
    Lie une API à son interface d’exécution ou de conception, servant de référence sans créer d’enregistrement dans le CMDB.

    Créer une relation ou une référence pour corriger les données d’API manquantes

    Améliorez l’efficacité opérationnelle de l’écosystème d’API au sein de votre organisation en créant une relation ou une référence pour les API qui manquent d’attributs clés tels que le contexte métier, les groupes de propriété, les modèles de produits ou les conceptions.

    Avant de commencer

    Rôle requis : sn_api_insights_ws.api_mgmt_architect, sn_cmdb_admin

    Pourquoi et quand exécuter cette tâche

    Les catégories de données manquantes disponibles sont les suivantes :
    • Contexte commercial manquant
    • Groupes de propriété manquants
    • Modèles de produit manquant
    • Conceptions manquantes
      Remarque :
      Affiché uniquement lorsque le module d’extension Digital Integration Management (sn_apm_di) est activé.

    Procédure

    1. Accédez à la Espaces de travail > Aperçus des API.
    2. Sélectionnez l’onglet Vue d’ensemble, s’il n’est pas déjà sélectionné par défaut.
    3. Sélectionnez une catégorie de données manquante pour ouvrir la liste des API manquantes pour cet attribut.
      • En tant qu’utilisateur disposant du rôle sn_api_insights_ws.api_mgmt_architect, dans la section Données manquantes des API, sélectionnez le nombre indiqué pour une catégorie de données manquantes spécifique.
      • En tant qu’utilisateur disposant du rôle sn_cmdb_admin, sélectionnez une barre de catégorie dans le graphique des données manquantes de l’API.
    4. Sur la page des données manquantes des API, cochez les cases en regard des noms des API.
    5. Résolvez les données manquantes.
      • Pour résoudre le contexte professionnel manquant, sélectionnez Créer des relations.
      • Pour résoudre les groupes de propriété, les modèles de produits ou les conceptions manquants, sélectionnez Créer une référence.
    6. Cochez les cases en regard de la colonne Nom des services d’application.
    7. En fonction du type de connexion requis, établissez des relations ou une référence.
      • Pour Contexte professionnel, sélectionnez Créer des relations.
      • Pour les groupes de propriété, le modèle de produit ou les conceptions, sélectionnez Créer une référence.
    8. Dans la boîte de dialogue qui s’affiche, sélectionnez Créer.