このページは Apigee と Apigee ハイブリッドに適用されます。
このトピックでは、AI によるスマート検索とフィルタベースの検索オプションを使用して API Hub で特定のリソースを検索する方法について説明します。
スマート検索による API Hub の検索
スマート検索を使用すると、API Hub に登録されている API リソースを簡単に検索して表示できます。スマート検索では、インスタンスで使用可能なすべての API リソースをフリーテキスト検索クエリによって検索できます。すべてのエンティティ タイプ（API、API オペレーション、仕様など）を検索するか、検索対象のエンティティ タイプを指定できます。
AI を搭載した検索エンジンにより、スマート検索は単語の「マッチング」を超えた検索を実現します。詳細な API リソース エントリ内のあらゆる場所から、入力されたフリーテキスト検索クエリと意味的に類似する語句を見つけ出し、その語句が含まれる結果を返します。
フリーテキスト検索では、次の詳細を含む検索結果のリストが複数のページに分かれて返されます。
- リソース名: API、API オペレーション、仕様ファイルの名前。
- リソースの説明: リソースの簡単な説明。
- リソースのオーナー: リソースのオーナーの名前とメールアドレス。
- リソースの詳細リンク: リソースの詳細情報ページへのリンク。
特定の語句を含む API を検索するには:
Google Cloud コンソールで、API Hub の [検出] ページに移動します。
検索ボックスに検索クエリを入力します。
たとえば、「Order management APIs (注文管理 API)」や「Spec file for wireless carrier settings (携帯通信会社の設定に使う仕様ファイル)」と入力します。
検索パラメータとしてシステム属性を使用して、検索を絞り込むことができます。API Hub で API を登録する際にユーザー定義の API 属性を作成した場合は、その属性を検索クエリに含めることもできます。
- [検索結果] リストには、入力した検索クエリと意味的に類似する語句を含む API リソースのリストが表示されます。
- API リソース名をクリックすると、リソースの詳細ページが表示されます。
- 現在のクエリを消去するには、[Clear results] をクリックします。
API による API Hub の検索
// TODO: これはプレビュー版で利用可能でしょうか？REST の例はありますか？フィルタベースの検索オプション
システム属性を検索パラメータとして使用して、[API] ページに表示された API のリストを絞り込むことができます。API ハブで API を登録する際にユーザー定義の属性を作成した場合は、その属性を検索クエリに組み込むこともできます。表示された API リソースのリストをカスタマイズする際は、次の機能を使用します。
フィルタ
フィルタベースのリスト検索を使用すると、リソースに関連付けられている事前定義済みのパラメータとシステム属性に基づいて、API のリストを効率化できます。フィルタ適用後のビューは、Match ALL または Match ANY のオプションによってカスタマイズできます。
フィルタ オプションを指定するには:
Google Cloud コンソールで、API Hub の [API] ページに移動します。
- [フィルタ] をクリックして、表をフィルタします。[フィルタ] ペインが開きます。
- 次のフィルタ オプションを指定または選択します。
- キーワード マッチ: 選択したフィルタのすべてに一致する（AND）API を表示するか、いずれかに一致する（OR）API を表示するかの選択
- ライフサイクル ステージ: API 開発の進行フェーズ
- ターゲット ユーザー: API の対象ユーザー（コンシューマー）
- スタイル: API の主なアーキテクチャ スタイル
- チーム: API を担当する制作チーム
- ビジネス ユニット: API を担当するビジネス ユニット
- [Toggle panel] をクリックして、[フィルタ] ペインを閉じます。
選択したフィルタ プロパティには、フィルタクエリが使用している条件ロジック（AND または OR）が表示されます。
- 個別のフィルタをクリアするには、フィルタの [X] をクリックします。すべてのフィルタをクリアするには、[フィルタ] ペインで [すべてクリア] をクリックします。
並べ替え
表示された API のリストを並べ替えるには:
Google Cloud コンソールで、API Hub の [API] ページに移動します。
デフォルトでは、[API] リストページが表示されます。
- [API] リストページで、[API 名] 列見出しを見つけます。
- 矢印は、現在の並べ替えの優先度を表します。 下矢印は降順を示し、 上矢印は昇順を示しています。
- [API 名] をクリックすると、API リストが名前で並べ替えられます。
ページネーション
API リソースが複数ある場合は、複数のページに分かれて表示されることがあります。
リストの表示をカスタマイズし、ページ間を移動するには:
Google Cloud コンソールで、API Hub の [API] ページに移動します。
デフォルトでは、[API] リストページが表示されます。
[API] リストで、下に示すページネーション ツールを見つけます。
- ページごとに表示する API の数を選択します。
- [> 進む] をクリックして次のページに移動します。
- [< 戻る] をクリックして前のページに移動します。