このチュートリアルでは、API を登録し、Azure portal を使用してメタデータを割り当てることで、組織の API センター で API インベントリを開始する方法について説明します。
Azure API Center でインベントリを作成できる API、API バージョン、定義、およびその他のエンティティの詳細については、「 主要な概念」を参照してください。
このチュートリアルでは、Azure portal を使用して次の操作を行う方法について説明します。
- 1 つまたは複数の API を登録する
- API 定義を含む API バージョンを追加する
[前提条件]
Azure サブスクリプション内の API センター。 作成するには、「 クイック スタート: API センターを作成する」を参照してください。
API センターに登録する 1 つ以上の API。 OpenAPI 定義へのリンクを含む 2 つの例を次に示します。
前のチュートリアル「カスタム メタデータの定義」を完了して、API の カスタム メタデータを定義します。
API の登録
API センターに API を登録 (追加) する場合、API の登録には以下が含まれます。
- タイトル (名前)、種類、説明
- バージョン情報
- ドキュメントと連絡先への省略可能なリンク
- 組み込みとカスタムのメタデータ (自分で定義したもの)
API を登録した後、API にバージョンと定義を追加できます。
以下の手順では、Swagger Petstore API と Conference API という 2 つのサンプル API を登録します (「前提条件」を参照してください)。 必要に応じて、独自の API を登録します。
Azure portal にサインインし、API センターに移動します。
サイドバー メニューで「資産」の下にある「API」を選択し、「+ API の登録」をクリックします。
[API の登録] ページで、Swagger Petstore API に関する次の情報を追加します。 前のチュートリアルで定義したカスタム の基幹業務 および 公開 メタデータがページの下部に表示されます。
Setting 価値 Description API タイトル 「Swagger Petstore API」と入力します。 API に対して選択した名前 ID 上記のタイトルを入力すると、Azure API Center によってこの識別子が生成され、この識別子はオーバーライドできます。 API の Azure リソース名 [API の種類] ドロップダウン リストから [REST] を選択します。 API の種類 まとめ 必要に応じて、概要を入力します。 API の概要の説明 説明 任意で説明を入力します。 API の説明 バージョン バージョン タイトル v1 など、任意のバージョン タイトルを入力します。 API バージョンに対して選択した名前 バージョン ID 上記のタイトルを入力すると、Azure API Center によってこの識別子が生成され、この識別子はオーバーライドできます。 バージョンの Azure リソース名 バージョンのライフサイクル ドロップダウンから [テスト] や [運用] などの選択を行います。 API バージョンのライフサイクル ステージ 外部ドキュメント 必要に応じて、外部ドキュメントへの 1 つ以上のリンクを追加します。 API のドキュメントの名前、説明、および URL ライセンス 必要に応じて、ライセンス情報を追加します。 API のライセンスの名前、URL、ID 連絡先情報 必要に応じて、1 つ以上の連絡先の情報を追加します。 API の連絡先の名前、電子メール、URL 業種 前のチュートリアルでこのメタデータを追加した場合は、ドロップダウンから選びます (マーケティングなど)。 API を所有する部署を識別するカスタム メタデータ 一般向け このメタデータを追加した場合は、チェックボックスをオンにします。 API が公開されているか内部のみであるかを識別するカスタム メタデータ 
[ 作成] を選択して API を登録します。
上記の 3 つの手順を繰り返して、Conference API などの別の API を登録します。
ヒント
Azure portal で API を登録する場合は、定義済みの API の種類のいずれかを選択するか、別の種類の API を入力できます。
API は、ポータルの [API] ページに表示されます。 API センターに多数の API を追加する場合は、このページの検索ボックスとフィルターを使用して、必要な API を見つけます。
API を登録すると、API のプロパティを表示または編集できます。 [API] ページで API を選び、API 登録を管理するためのページを表示します。
API バージョンを追加する
そのライフサイクル全体を通して、API には複数のバージョンを含めることができます。 必要に応じて、1 つまたは複数の定義ファイルを使用して、API センターの既存の API にバージョンを追加できます。
ここでは、次のいずれかの API にバージョンを追加します。
Azure portal で、API センターに移動します。
サイドバー メニューで [API] を選択し、 API (Swagger Petstore など) を選択します。
[API] ページの [詳細] で、[バージョン]>[+ バージョンの追加] を選択します。
[ API バージョンの追加 ] ページで、[ バージョンの詳細] で次の情報を入力または選択します。
Setting 価値 Description バージョン タイトル [v2] など、任意のバージョン タイトルを入力します。 API バージョンに対して選択した名前 バージョン ID 上記のタイトルを入力すると、Azure API Center によってこの識別子が生成され、この識別子はオーバーライドできます。 バージョンの Azure リソース名 バージョンのライフサイクル [運用] などのドロップダウンから選択します。 API バージョンのライフサイクル ステージ Azure API Center では、REST API の OpenAPI 2 や 3 など、一般的なテキスト仕様形式の定義がサポートされています。 API 定義を追加するには、[仕様の選択] で次の情報を入力または 選択します。
Setting 価値 Description 定義のタイトル 「v2 定義」など、任意のタイトルを入力します。 API 定義に選択する名前 定義の識別 上記のタイトルを入力すると、Azure API Center によってこの識別子が生成され、この識別子はオーバーライドできます。 定義の Azure リソース名 説明 任意で説明を入力します。 API 定義の説明 仕様の形式 Petstore API の場合は、[OpenAPI] を選択します。 API の仕様形式 仕様バージョン 3.0 など、任意のバージョン識別子を入力します。 仕様バージョン ファイル または URL Petstore API のローカル定義ファイルを参照するか、URL を入力します。 URL の例: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yamlAPI 定義ファイル 
を選択してを作成します。
API インベントリを構築するときは、自動ツールを利用して API を登録します。たとえば、Visual Studio Code 用の Azure API Center 拡張機能や、Azure CLI などです。
次のステップ
API インベントリが形になり始めています。 これで、API 環境とデプロイに関する情報を追加できます。