API インサイトを使用した API データの欠落の特定と解決

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:3分
  • 欠落している要素をリンクし、完全な API レコードを検証することで、API インサイトワークスペース内の API データの欠落を特定して解決します。

    API インサイトワークスペースの [概要] ページでは、構成管理データベース (CMDB)内の不完全または不足しているデータにフラグを立てることで、API の使いやすさ、ガバナンス、および統合を向上させることができます。

    主要メトリクスの監視

    sn_api_insights_ws.api_mgmt_architect ロールを持つ API インサイトアーキテクトは、組織内の API に関連する次の不足データを監視できます。
    ビジネスコンテキストがありません
    API が ビジネスコンテキスト に関連付けられていないと、どのビジネス領域が API を提供しているかについての明確さとガバナンスが低下します。
    不足している所有グループ
    所有グループがアサインされていない API はガバナンスに影響します。所有グループをアサインすることで、修復の追跡、アクセスの管理、問題の迅速な解決が簡素化されます。
    不足している製品モデル
    製品モデルがアサインされていない API があると、正確なレポートを提供する能力や、バージョンアップされた API との対話が制限されます。
    デザインがありません
    設計の具現化が行われていない API は、システムへの完全な統合の妨げとなります。これらの API を、設計時点での対応するもの (デジタルインターフェイスレコードなど) とリンクさせることで、使いやすさと運用効率が向上します。

    API データの欠落の解決

    API と CMDB内の他の CI との間の接続を確立する、ビジネスコンテキストの関係または所有グループ、製品モデル、または設計の参照を作成することで、API データの欠落を解決できます。データギャップを解決することで、依存関係と所有権をより完全かつ正確に把握し、影響度評価とサービス管理を改善できます。

    API データの欠落を解決するために、 API インサイト で次の関係または参照を確立できます。

    API とビジネス間のコンテキスト 関係
    API を特定の ビジネスコンテキストにリンクし、API が使用されるコンテキストを定義し、 CMDBに関係レコードを作成します。
    API から所有グループ への参照
    API をガバナンス、アクセス制御、およびメンテナンスを担当するグループにリンクしCMDB にレコードを作成せずに参照として機能します。
    API から製品モデル へのリファレンス
    API を製品モデルにリンクし、API のバージョニング、製品ライン、およびライフサイクルステージに関する情報を提供しCMDBでレコードを作成することなく参照できるようにします。
    API-to-design リファレンス
    API をランタイムインターフェイスまたは設計時インターフェイスにリンクし、 CMDBにレコードを作成せずに参照として機能します。

    API データの欠落を解決するための関係または参照の作成

    ビジネスコンテキスト、所有グループ、製品モデル、設計などの主要な属性を持たない API の関係または参照を作成することで組織内の API エコシステムの運用効率を向上させます。

    始める前に

    必要なロール:sn_api_insights_ws.api_mgmt_architect

    手順

    1. 次のように移動する。 ワークスペース > API インサイト > 概要.
    2. [不足している API データ (APIs missing data)] セクションで、欠損データのカテゴリを選択します。
      次のカテゴリを利用できます。
      • ビジネスコンテキストがありません
      • 不足している所有グループ
      • 不足している製品モデル
      • 欠損設計
    3. カテゴリに表示されている番号を選択して、そのカテゴリでデータが不足している API のリストを確認します。
    4. [不足している API データ (APIs missing data)] ページで、[ 名前 ] 列の横にあるチェックボックスをオンにして API を選択します。
    5. データギャップを解決します。
      • 欠落しているビジネスコンテキストを解決するには、[ 関係を作成] を選択します。
      • 不足している所有グループ、製品モデル、または設計を解決するには、[ 参照を作成] を選択します。
    6. 欠落しているデータ属性の [名前 ] 列の横にあるチェックボックスをオンにします。
    7. 必要な接続のタイプに基づいて、関係または参照を確立します。
      • ビジネスコンテキストの場合は、[ リレーションシップの作成] を選択します。
      • 所有グループ、製品モデル、または設計の場合は、[ 参照を作成] を選択します。
    8. 表示されるダイアログボックスで、[作成] を選択します。