Affichage de toutes les API dans Aperçus des API

Gérez et surveillez toutes les API au sein de votre organisation en examinant leurs étapes de cycle de vie, en identifiant les attributs critiques manquants et en accédant à des ressources utiles pour assurer une maintenance et une gouvernance appropriées des API.

La page Toutes les API de l’espace Aperçus des API de travail fournit une vue d’ensemble complète de toutes les API au sein d’une organisation, garantissant que les API sont correctement maintenues et alignées sur les normes de l’organisation en matière d’interfaces, de propriété et de modèles de produits.

Figure 1. Page Toutes les API

Accéder à la page Toutes les API et l’utiliser

Pour accéder à la page Toutes les API, accédez à Espaces de travail > Aperçus des API, puis sélectionnez l’onglet API .

Affichage des données

Par défaut, la page affiche les données suivantes :

Liste Toutes les API

Affiche le nombre total d’API gérées par l’organisation et les classe par étape de leur cycle de vie (Toutes les API, En cours de conception, Opérationnel, En fin de vie). Vous pouvez sélectionner chaque carte pour afficher les API par étape de leur cycle de vie dans la table de données de l’API.

Table de données de l’API

Répertorie toutes les API avec des colonnes détaillées pour le nom de l’API, le nombre de consommateurs, la plateforme de gestion, l’étape du cycle de vie, la version et le nombre de demandes d’API traitées par minute pour chaque API répertoriée dans la table. Ce tableau fournit une vue d’ensemble des API et de leur état au sein de l’organisation. Vous pouvez sélectionner une API dans la colonne Nom pour afficher les détails de l’API et demander l’accès à l’API gérée par votre équipe. Consultez Demander l’accès à une API dans Aperçus des API.

Actions et filtres disponibles dans la table de données de l’API

Fournit plusieurs actions et options de filtrage pour gérer et affiner les données affichées. Il s’agit notamment de l’exportation de la liste dans différents formats, de l’actualisation des données et de l’application de filtres pour affiner les résultats par type de plateforme, instance ou critères de colonne spécifiques.

Exportation de données d’API

Exportez la liste des API au format PDF, CSV, JSON ou Microsoft Excel fichier en sélectionnant Exporter, puis le format de fichier souhaité dans la liste Type de fichier. Vous pouvez télécharger le fichier dans votre répertoire local ou l’envoyer par e-mail en sélectionnant une valeur dans la liste Type de livraison. Après avoir effectué vos sélections, sélectionnez Exporter pour terminer le processus.

Actualisation des données de l’API

Remplissez manuellement la table de données de l’API à la demande en sélectionnant l’icône d’actualisation (icône

Filtrage des API par plateforme et instance

Réduisez la liste des API en fonction du type de plateforme et de l’instance.

• Utilisez la liste Type de plateforme de gestion pour filtrer les API par catégorie de plateforme.
• Utilisez la liste des instances de la plateforme de gestion pour affiner les résultats selon une instance spécifique ServiceNow .

Sélectionnez Appliquer pour mettre à jour la liste en fonction des filtres sélectionnés. Si vous sélectionnez TOUT dans l’une ou l’autre des listes, les API de toutes les options disponibles sont incluses dans la table.

Application de filtres aux colonnes de données de l’API

Affinez la liste des API à l’aide de filtres spécifiques aux colonnes ou d’ensembles de conditions avancés.

Chaque colonne de la liste All API (Toutes les API) comprend des options de filtrage en ligne légères :

Opérateur

Inclut l’opérateur de comparaison pour le filtre. La liste des opérateurs comprend est, n’est pas, commence par, se termine par, contient, ne contient pas, est vide, n’est pas vide. Dans le champ Valeur , vous pouvez entrer le texte ou le numéro sur lequel vous souhaitez filtrer, puis appuyer sur la touche Entrée. La liste s’actualise lorsque le filtre est appliqué.

Par exemple, la sélection de contient et l’entrée d’une valeur dans le champ Valeur filtre la liste pour afficher uniquement les enregistrements d’API dans lesquels la colonne contient ce texte.

Ouvrir le panneau

Ouvre le panneau de filtre complet de la colonne sélectionnée et fournit un contrôle plus fin sur les filtres pour affiner les données de la table en fonction des paramètres les plus importants pour votre analyse.

Vous pouvez définir des conditions personnalisées pour affiner les données en sélectionnant un champ, en choisissant un opérateur, tel que égal ou contient, et en saisissant une valeur spécifique. Vous pouvez ajouter plusieurs conditions pour affiner davantage votre recherche, et une fois que vous avez défini les filtres, sélectionner Exécuter met à jour la table de données de l’API en conséquence. Le commutateur Show labels (Afficher les étiquettes ) contrôle si les étiquettes des champs et des opérateurs sont affichées. Lorsqu’elle est activée, elle affiche un texte descriptif à côté de chaque option pour vous aider à comprendre son objectif, tandis que sa désactivation masque les étiquettes pour une vue plus compacte.

Ajouter un filtre

Règle de filtrage en ligne ajoutée pour une colonne afin que vous puissiez définir immédiatement des conditions à l’aide des champs opérateur et valeur. Par exemple, lors du filtrage par Type, vous pouvez choisir REST, SOAP, gRPC, Websocket, REST scripté et d’autres options prédéfinies.

Section des données manquantes pour les API

Met en évidence les attributs clés manquants des API tels que le contexte métier, les groupes de propriété, les modèles de produits et la conception , ce qui permet d’identifier les problèmes de gouvernance des API. Vous pouvez sélectionner la valeur numérique affichée dans chaque carte pour identifier et résoudre les problèmes liés aux données d’API. Consultez Identification et correction des données d’API manquantes dans Aperçus des API.

Ressources utiles

Contient des liens rapides vers la documentation produit, les articles de la base de connaissances et les forums de la communauté, ce qui permet d’accéder facilement à des ressources supplémentaires pour la gestion des API.