で不足している API データの特定と修正 API インサイト
欠落している要素をリンクし、完全な API レコードを検証することで、 API インサイト ワークスペースで不足している API データを特定して修正します。
メタデータが欠落していると、API ディスカバリー、ライフサイクル追跡、および所有権の説明責任の有効性が低下する可能性があります。欠落している一般的な要素は次のとおりです。
- ビジネスコンテキスト
- 所有グループ
- 製品モデル
- 設計の詳細
欠落しているデータを解決することで、依存関係と所有権をより完全かつ正確に把握し、影響度評価とサービス管理を改善します。
API インサイトワークスペースの [概要] タブでは、構成管理データベース (CMDB)内の不完全または欠落しているデータをハイライト表示することで、API の使いやすさ、ガバナンス、および統合を改善できます。
ロール別の不足している API データの修正
次のロールは、API で不足しているメタデータを特定して解決できます。
- sn_api_insights_ws.api_mgmt_architect ロールを持つエンタープライズアーキテクトは、 API インサイト ワークスペースの [概要] タブにアクセスし、不足しているデータのタイプごとに専用タイルを使用して不足している API 情報を修正できます。
- sn_cmdb_admin ロールを持つ CMDB アドミニストレーターは、 API インサイト ワークスペースの [概要] タブにアクセスし、[不足している 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、sn_cmdb_admin
このタスクについて
利用可能な欠損データのカテゴリは次のとおりです。
- ビジネスコンテキストがありません
- 所有グループがありません
- 製品モデルがありません
- 欠損設計注:デジタル統合管理プラグイン (sn_apm_di) がアクティブになっている場合にのみ表示されます。
手順
- 移動先 .
- デフォルトで [概要] タブを選択します (まだ選択されていない場合)。
-
不足しているデータカテゴリを選択して、その属性が不足している API のリストを開きます。
- sn_api_insights_ws.api_mgmt_architect ロールを持つユーザーは、[不足している API データ (APIs missing data)] セクションで、特定の不足データカテゴリに表示される数を選択します。
- sn_cmdb_adminロールを持つユーザーは、[API 不足データ (APIs missing data)] 棒グラフでカテゴリ棒を選択します。
- [不足している API データ (APIs missing data)] ページで、API 名の横にあるチェックボックスをオンにします。
-
欠落しているデータを解決します。
- 欠落しているビジネスコンテキストを解決するには、[ 関係を作成] を選択します。
- 不足している所有グループ、製品モデル、または設計を解決するには、[ 参照を作成] を選択します。
- アプリケーションサービスの [名前 ] 列の横にあるチェックボックスをオンにします。
-
必要な接続のタイプに基づいて、関係または参照を確立します。
- ビジネスコンテキストの場合は、[ リレーションシップの作成] を選択します。
- 所有グループ、製品モデル、または設計の場合は、[ 参照を作成] を選択します。
- 表示されるダイアログボックスで、[作成] を選択します。