Identification et résolution des lacunes en matière de données d’API avec Aperçus des API

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture

    • Identifiez et résolvez les lacunes en matière de données d’API dans l’espace de travail en liant les éléments manquants et en vérifiant les enregistrements d’API Aperçus des API complets.

    La page 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 signalant toute donnée incomplète ou manquante dans le Base de données de gestion des configurations (CMDB).

    Mesures clés de surveillance

    Aperçus des API En tant qu’architecte disposant du rôle sn_api_insights_ws.api_mgmt_architect, 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 produits manquants
    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 lacunes en matière de données d’API

    Vous pouvez résoudre les écarts de données d’API en créant une relation pour le contexte professionnel ou une référence pour les groupes de propriété, les modèles de produits ou les conceptions, qui établit des connexions entre l’API et d’autres CI au sein de .CMDB La résolution des lacunes en matière de données garantit une vue plus complète et plus précise des dépendances et de la propriété, améliorant ainsi les évaluations d’impact et la gestion des services.

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

    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 résoudre les lacunes en matière de données d’API

    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

    Procédure

    1. Accédez à la Espaces de travail > Aperçus des API > Vue d'ensemble.
    2. Dans la section Données manquantes des API, sélectionnez une catégorie de données manquantes.
      Les catégories suivantes sont disponibles :
      • Contexte professionnel manquant
      • Groupes de propriété manquants
      • Modèles de produits manquants
      • Conceptions manquantes
    3. Sélectionnez le nombre affiché dans la catégorie pour examiner la liste des API pour lesquelles il manque des données dans cette catégorie.
    4. Sur la page des données manquantes des API, cochez les cases en regard de la colonne Nom pour sélectionner les API.
    5. Résolvez les lacunes dans les données.
      • 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 la case à côté de la colonne Nom pour l’attribut de données manquant.
    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.