API インサイトでのすべての API の表示
ライフサイクルステージを確認し、不足している重要な属性を特定して、適切な API メンテナンスとガバナンスを確保するために役立つリソースにアクセスすることで、組織内のすべての API を管理および監視します。
API インサイトワークスペースの [すべての API (All APIs)] ページには、組織内のすべての API の包括的な概要が表示されます。これにより、API が適切に管理され、インターフェイス、所有権、および製品モデルに関する組織の標準に沿っていることを確認することができます。
[すべての API (All APIs)] ページへのアクセスとその使用
[すべての API (All APIs)] ページにアクセスするには、 をクリックし、[ API ] タブを選択します。
データの表示
デフォルトでは、このページには次のデータが表示されます。
- すべての API リスト
- 組織によって管理されている API の合計数を表示し、ライフサイクルステージ (すべての API、設計中、稼働中、提供終了) 別に分類します。各カードを選択すると、API データテーブルでライフサイクルステージ別に API を表示できます。
- API データテーブル
- すべての API を、API 名、コンシューマーの数、管理プラットフォーム、ライフサイクルステージ、バージョン、およびテーブルにリストされている API ごとに 1 分あたりに処理される API 要求の数の詳細な列とともに一覧表示します。このテーブルは、組織内の API とそのステータスの概要を示しています。[名前] 列から API を選択して API の詳細を表示し、チームによって管理されている API へのアクセスを要求できます。「API インサイトでの API へのアクセスの要求」を参照してください。
- API データテーブルで利用可能なアクションとフィルター
- 表示されるデータを管理および絞り込むためのいくつかのアクションとフィルタリングオプションを提供します。これには、さまざまな形式でのリストのエクスポート、データの更新、プラットフォームタイプ、インスタンス、または特定の列基準による結果の絞り込みのためのフィルターの適用が含まれます。
- API データのエクスポート
- [エクスポート] を選択し、[ファイルタイプ] リストから目的のファイル形式を選択して、API リストを PDF、CSV、JSON、または Microsoft Excel ファイルとしてエクスポートします。ローカルディレクトリにファイルをダウンロードするか、[配信タイプ] リストから値を選択してファイルをメールで送信できます。選択を行った後、[エクスポート] を選択してプロセスを完了します。
- API データのリフレッシュ
- リフレッシュアイコン (リ
を選択して、オンデマンドで API データテーブルに手動で入力します。
- プラットフォームとインスタンスによる API のフィルタリング
- プラットフォームタイプとインスタンスに基づいて API リストを絞り込みます。
- [管理プラットフォームタイプ] リストを使用して、プラットフォームカテゴリ別に API をフィルタリングします。
- [管理プラットフォームインスタンス] リストを使用して、特定の ServiceNow インスタンス別に結果を絞り込みます。
- API データ列へのフィルターの適用
- 列固有のフィルターまたは詳細条件セットを使用して、API のリストを絞り込みます。
[すべての API (All APIs)] リストの各列には、軽量のインラインフィルタリングオプションが含まれています。
- 演算子
- フィルターの比較演算子が含まれます。演算子リストには、
is、is not、starts with、ends with、contains、doesnot contain、isempty、is not emptyなどがあります。[ 値] フィールドに、フィルターを適用するテキストまたは数値を入力し、Enter キーを押します。フィルターが適用されると、リストが更新されます。たとえば、[ 次の値を含む ] を選択して [値 ] フィールドに値を入力すると、リストがフィルタリングされ、そのテキストが列に含まれている API レコードのみが表示されます。
- パネルを開く
- 選択した列のフルフィルターパネルを開き、フィルターをより細かく制御して、分析にとって最も重要なパラメーターに従ってテーブル内のデータを絞り込むことができます。
フィールドを選択し、「等しい」や「次を含む」などの演算子を選択して、特定の値を入力することで、データを絞り込むためのカスタム条件を定義できます。複数の条件を追加して検索をさらに絞り込むことができ、フィルターを設定したら [実行] を選択すると、それに応じて API データテーブルが更新されます。[ ラベルを表示] 切り替えスイッチは、フィールドと演算子のラベルを表示するかどうかを制御します。有効にすると、各オプションの横に説明テキストが表示され、目的を理解するのに役立ちますが、無効にすると、よりコンパクトなビューのためにラベルが非表示になります。
- フィルターを追加
- 列にインラインフィルタールールが追加され、演算子フィールドと値フィールドを使用して条件をすぐに定義できます。たとえば、 タイプでフィルタリングする場合は、REST、SOAP、gRPC、Websocket、スクリプト化された REST、およびその他の事前定義されたオプションを選択できます。
- [不足している API データ (APIs missing data)] セクション
- ビジネスコンテキスト、所有グループ、製品モデル、設計などの主要な属性が欠落している API を強調表示し、API ガバナンスの問題を特定するのに役立ちます。各カードに表示される数値を選択して、API データの問題を特定して解決できます。「API インサイトで不足している API データの特定と修復」を参照してください。
- 役に立つリソース
- 製品ドキュメント、ナレッジベース記事、およびコミュニティフォーラムへのクイックリンクが含まれており、API 管理の追加リソースに簡単にアクセスできます。