分類を管理します

このページは ApigeeApigee ハイブリッドに適用されます。

分類は API を整理する 1 つの方法であり、メタデータを定義するための柔軟なオプションを提供します。分類は値の名前付きリストであり、システムで定義されます。分類により、特定の情報を分類できるようになります。[分類] 設定ページでは、システムで使用可能なさまざまな分類を表示、管理できます。

[分類] タブ、クリックして画像を拡大

システム分類は、API Hub で特別な意味を持つ値を定義します。また、UI で特別な方法で表示することや、動作を指示することができます。システム分類はシステムによって事前に定義されており、変更や拡張の方法がさらに制限されています。ただし、値のリストはある程度変更できます。

カスタム分類では、API に追加するカスタム情報を定義します。管理者の権限が付与されている場合は、このリストを自由に作成して変更できます。

ほとんどの分類は排他的です。ラベルによって、重複しない(単一選択)コレクションに項目がグループ化されます。ただし必要に応じて、1 つのオブジェクトに複数のラベルを割り当てるように分類を構成できます。このような複数選択の分類は、その構成で複数選択としてマークされています。

事前定義のシステム分類

次の事前定義のシステム分類は削除できません。また、その構成の一部は編集できません。また、次に示す事前定義のシステム分類の一部は、事前定義要素を指定します。

  • Target users: API の対象ユーザー(コンシューマ)(複数選択可)。
  • Style (primary): API のプライマリ アーキテクチャ スタイル(単一選択のみ)。
  • Team: API を担当する制作チーム(単一選択のみ)
  • Business unit: API を担当するビジネス ユニット(単一選択のみ)
  • Gateway: API の提供と保護に使用されるプロキシ(単一選択のみ)

カスタム分類

カスタム分類により、カスタム情報を API に追加できます。次に例を示します。

  • 承認: [Compliant] や [Regulated] などのレビュー ステータス
  • トピック: 対象分野(FinanceHR など)によって API を分類します。
  • 属性: Contains PII などの API の機能
  • プロダクト: API でサポートするように設計されている一般ユーザー向けプロダクト

分類の追加

分類を追加するには:

  1. Google Cloud コンソールで、[API Hub]、[設定]、[分類] ページに移動します。

    API Hub の [分類] に移動

  2. [カスタム分類を追加] をクリックします。
  3. 以下を指定します。
    • ID: API リソースの識別子。ID に使用できるのは小文字、数字、ハイフンのみです。この ID はプロジェクト内で一意である必要があります。ID は 4~63 文字にする必要があります。分類の作成後に ID を変更することはできません。たとえば、API リソース名 projects/my-project/locations/global/apis/my-api の場合、リソース ID は my-api です。
    • 名前: 分類の表示名。
    • 説明: 分類の簡単な説明。
    • オプション:
      • 選択を 1 つに制限する: 選択すると、常に 1 つの分類値のみを API に適用できます。複数の値がすでに API に適用されており、このオプションが有効になっている場合、複数の値は維持されます。
      • 検索フィルタから除外する: 選択すると、この分類が [フィルタ] ペインに表示されなくなります。
    • 分類要素: 名前と、説明または URL ペアのリスト。このペアにより、分類に使用可能な値が定義されます。
      • 名前: 名前は、分類表示名に基づいて自動的に生成されます。これは、[概要] ページの 情報アイコンの上にマウスを置くと表示される名前です。
      • URL: URL を入力すると、分類要素が URL として表示されます。
      • 別の要素を追加するには、[要素を追加] をクリックします。
  4. [保存] または [キャンセル] をクリックします。

分類の編集

分類を編集するには:

  1. Cloud コンソールで、[API Hub]、[設定]、[分類] ページに移動します。

    API Hub の [分類] に移動

  2. システム分類の横にある 編集)をクリックするか、カスタム分類の横にある その他)> [ 編集] をクリックします。
  3. 必要に応じて変更を行います。システム分類のフィールドは、変更できないものもあります。詳細については、事前定義のシステム分類をご覧ください。

  4. [保存] または [キャンセル] をクリックします。

分類の削除

分類を削除するには:

  1. Cloud コンソールで、[API Hub]、[設定]、[分類] ページに移動します。

    API Hub の [分類] に移動

  2. 目的の分類の横にある その他)> 削除をクリックします。

  3. 確認プロンプトで [削除] または [キャンセル] をクリックします。

分類リストの並べ替え

分類を並べ替えることで、API の [フィルタ] ペインと [概要] ページでの分類の表示順序を決定できます。

分類リストを並べ替えるには:

  1. Cloud コンソールで、[API Hub]、[設定]、[分類] ページに移動します。

    API Hub の [分類] に移動

  2. ライフサイクルの目的の位置になるまで、(上矢印)または (下矢印)をクリックします。