このチュートリアルでは、API センターで API やその他の情報を整理するのに役立つカスタム メタデータを定義する方法について説明します。 カスタムおよび組み込みのメタデータを使用して、検索とフィルター処理を行い、組織内でガバナンス標準を適用できます。
Azure API Center のメタデータの詳細については、次を参照してください。
このチュートリアルでは、Azure portal を使用して次の操作を行う方法について説明します。
- API センターでカスタム メタデータを定義する
- メタデータ スキーマを表示する
[前提条件]
- Azure サブスクリプション内の API センター。 作成するには、「 クイック スタート: API センターを作成する」を参照してください。
メタデータの定義
ここでは、2 つのカスタム メタデータの例を定義します。 基幹業務 と 一般向けです。必要に応じて、独自の他のメタデータを定義します。 インベントリ内の API やその他の情報を追加または更新する場合は、カスタムメタデータと一般的な組み込みメタデータの値を設定します。
Important
定義したメタデータのタイトル (名前) には、機密性の高い、機密性の高い、または個人情報を含めないでください。 これらのタイトルは、サービスの機能を向上させるために Microsoft によって使用される監視ログに表示されます。 ただし、その他のメタデータの詳細と値は、保護された顧客データです。
Azure portal にサインインし、API センターに移動します。
サイドバーメニューの[ アセット]で、[ メタデータ>+ 新しいメタデータ]を選択します。
[ 詳細 ] タブで、メタデータに関する情報を入力します。
[タイトル] に「基幹業務」と入力します。
必要に応じて、説明を入力します。
種類 [定義済みの選択肢 ] を選択し 、マーケティング、財務、IT、営業などの選択肢を入力します。 必要に応じて、[ 複数の値の選択を許可する] を有効にします。 [次へ] を選択します。
[ 割り当て ] タブで、[API に 必須 ] を選択します。 デプロイメントと環境の項目で[省略可能]を選択します。 これらのエンティティは、後のチュートリアルで追加できます。 [次へ] を選択します。
[ 確認と作成 ] タブで設定を確認し、[ 作成] を選択します。
メタデータが [メタデータ ] ページの 一覧に追加されます。
[+ 新しいメタデータ] を選択して、別の例を追加します。
[ 詳細 ] タブで、メタデータに関する情報を入力します。
タイトルにPublic-facingと入力します。
ブール型を選択します。
[ 割り当て ] タブで、[API に 必須 ] を選択します。 「展開」と「環境」には適用されないを選択します。
[ 確認と作成 ] タブで設定を確認し、[ 作成] を選択します。
メタデータが一覧に追加されます。
メタデータ スキーマの表示
API センターで定義されているメタデータの JSON スキーマを表示およびダウンロードできます。 スキーマには、組み込みメタデータとカスタム メタデータが含まれています。
左側のメニューの [ 資産] で、[ メタデータ>メタデータ スキーマの表示] を選択します。
[メタデータ スキーマの表示>API] を選択して、組み込みメタデータとカスタム メタデータを含む API のメタデータ スキーマを表示します。 また、API センターのデプロイと環境に対して定義されているメタデータ スキーマを表示することもできます。
次のステップ
API センターのインベントリに API を追加します。