チュートリアル: カスタム メタデータを定義する

このチュートリアルでは、API センターで API やその他の情報を整理するのに役立つカスタム メタデータを定義します。 検索とフィルター処理のためにカスタムと組み込みのメタデータを使用し、さらに組織内でガバナンス標準を適用します。

Azure API Center でのメタデータの背景情報については、以下を参照してください。

• 主要な概念
• API ガバナンスのメタデータ

このチュートリアルでは、ポータルを使用して次のことを行う方法を説明します。

前提条件

• Azure サブスクリプション内の API センター。 まだ作成していない場合は、「クイック スタート: API センターを作成する」を参照してください。

メタデータを定義する

ここでは、2 つのカスタム メタデータの例として、Line of business と Public-facing を定義します。必要に応じて、独自のその他のメタデータを定義します。 インベントリ内の API やその他の情報を追加または更新するときは、カスタムと一般的な組み込みメタデータの値を設定します。

1. Azure portal で、API センターに移動します。

2. 左側のメニューにある [資産] で、[メタデータ] > [+ 新しいメタデータ] を選択します。

3. [詳細] タブで、メタデータに関する情報を入力します。

   1. [タイトル] に「業種」と入力します。

   2. 必要に応じて、説明を入力します。

   3. [定義済みの選択肢] のタイプを選択し、マーケティング、財務、IT、営業などの選択肢を入力します。 必要に応じて [複数の値の選択を許可] を有効にします。 [次へ] を選択します。

   

4. [割り当て] タブで、API に対して [必須] を選択します。 [デプロイと環境] には、[省略可能] を選択します。 (これらのエンティティは、後のチュートリアルで追加します)。[次へ]を選択します。

   

5. [確認 + 作成] タブで設定を確認し、[作成] を選択します。

   メタデータが [メタデータ] ページの一覧に追加されます。

6. [+ 新しいメタデータ] を選択して、別の例を追加します。

7. [詳細] タブで、メタデータに関する情報を入力します。

   1. [タイトル] に、「Public-facing」と入力します。

   2. [Boolean] 型を選択します。

8. [割り当て] タブで、API に対して [必須] を選択します。 [デプロイと環境] で [適用なし] を選択します。

9. [確認 + 作成] タブで設定を確認し、[作成] を選択します。

   メタデータが一覧に追加されます。

メタデータ スキーマを表示する

API センターで定義したメタデータの JSON スキーマを表示およびダウンロードできます。 スキーマには、組み込みとカスタムのメタデータが含まれています。

1. 左側のメニューにある [資産] で、[メタデータ] > [メタデータ スキーマの表示] を選択します。

2. [メタデータ スキーマの表示] > [API] を選択して、組み込みとカスタムのメタデータを含む API のメタデータ スキーマを確認します。 また、API センターでデプロイと環境に対して定義されているメタデータ スキーマを表示することもできます。

   

次のステップ

このチュートリアルでは、ポータルを使用して次のことを行う方法を説明します。

メタデータ スキーマを準備したので、API センターでインベントリに API を追加します。