API Center の使用を開始する

ステップ 1: API Center サービスを作成する

1. Azure portalにサインインします。

2. 検索バーに「API Centers」と入力します。

3. [+ 作成] を選択します。

4. [基本] タブで、次の設定を入力または選択します。

   a. Azure サブスクリプションを選択します。

   b. 既存のリソース グループを選ぶか、[新規] を選んで新しく作成します。

   c. API センターの名前を入力します。 これは、API センターを作成しているリージョン内で一意である必要があります。

   d. [リージョン] で、API Center に利用できるリージョンのいずれかを選びます。

   e. 価格プランで、[無料試用版 (90 日間 0 ドル)] を選びます。

   f. [Review + create](レビュー + 作成) を選択します。

   h. 検証が完了した後、 [作成] を選択します。

   デプロイ後に API センターを使用する準備ができます。

CLI 参照コマンドをローカル環境で実行するには、Azure CLI をインストールし、次のコマンドを使ってログインします。

az login

az provider register –namespace Microsoft.ApiCenter 

ステップ 1: API Center サービスを作成する

次のコマンドを実行して次の値を渡し、リソース グループを作成します。

• --name: リソース グループ名。例: Contoso
• --location: 場所。例: eastus

az group create –-name contoso –-location eastus  

次のコマンドを実行して次の値を渡し、API Center を作成します。

• -n: API センター サービス名。例: contoso-apis
• -g: リソース グループ。例: Contoso
• --l: 場所。例: eastus

az apic create -n contoso-apis -g contoso -l eastus 

1. 左側のメニューで、[資産] > [メタデータ] > [+ 新しいメタデータ] を選びます。

2. [詳細] タブで、 プロパティに関する情報を入力します。

   a. [タイトル] に、「API Approver」と入力します

   b. [説明] に、「Default API Approver」と入力します

   c. 種類として [文字列] を選んで、[次へ] を選びます

3. [割り当て] タブで、API に対して [必須] を選択します。 [デプロイと環境] には、[省略可能] を選択します。 [次へ] を選択します

4. [作成] を選択します

5. 次の図に示すように、Public-facing プロパティに対して同じ手順を繰り返します。 種類として、[ブール] を選びます

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

7. [作成] を選択します

8. 次の図に示すように、Compliance-review プロパティに対して同じ手順を繰り返します。 種類として [定義済み選択肢] を選び、「Not Started」、「In Progress」、「Completed」の 3 つの選択肢を追加します

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

10. [次へ] を選択します

API の JSON メタデータ スキーマを表示、編集、ダウンロードできるようになりました。 表示するには、[メタデータ スキーマの表示] を選んで、ドロップダウンから [API] を選びます。

これにより、メタデータの詳細を含むモーダルが右側に開きます。これには、LifecycleStage、Name、Description、TermsOfService などの API Center の組み込みプロパティが含まれます。 ファイルの一番下までスクロールすると、次のように、前の手順で追加したカスタム メタデータが表示されます。

次のコマンドを実行して新しいメタデータ スキーマを作成し、次のように設定します。

• メタデータの名前は api-approver として
• スキーマはプロパティの種類を文字列として、タイトルを API 承認者として
• 割り当ては API については必須として、環境とデプロイについてはオプションとして

az apic metadata create -g contoso -n contoso-apis --metadata-name "api-approver" --schema '{"type":"string","title":"API Approver"}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

次について、同じ手順を実行します。

• メタデータの名前は public-facing として
• スキーマはプロパティの種類をブール値として、タイトルを公開として
• 割り当ては API については必須として、環境とデプロイについてはオプションとして

次のコマンドを実行します。

az apic metadata create -g contoso -n contoso-apis --metadata-name "public-facing" --schema '{"type":"boolean", "title":"Public Facing"}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

最後に、次について、同じ手順を実行します。

• メタデータの名前は compliance-review として
• スキーマはプロパティの種類を文字列として、タイトルをコンプライアンス レビューとして
• 割り当ては API については必須として、環境とデプロイについてはオプションとして

次のコマンドを実行します。

az apic metadata create -g contoso -n contoso-apis --metadata-name "compliance-review" --schema '{"type":"string","title":"Compliance Review", "oneOf":[{"const":"Not Started","description":""},{"const":"In Progress","description":""},{"const":"Completed","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

次のコマンドを実行して、API Center で定義されているすべてのメタデータのリストを表示できます。

az apic metadata list -g <resource-group-name> -n <api-center-name> 

1. ポータルで、API Center に移動します。

2. 左側のメニューで、[資産] > [API] > [+ API の登録] を選びます。

3. [API の登録] ページで、API に関する次の必要な情報を追加します。 ページの下部に、前の手順で定義したカスタム メタデータ プロパティ API Approver、*Public-facing、compliance-review が表示されます。

作成した API を表示するには、左側のメニューで [資産] > [API] > [Conference API] を選びます。

[概要] タブには、API 構成のビューが表示されます。 API のバージョンやデプロイなどの追加情報を表示および編集するには、[詳細] を展開します (現時点ではデプロイはありません)。

通常は、API バージョンの API 定義を追加する必要があります。API Center では、OpenAPI 2 や REST 用の OpenAPI 3 などのテキスト指定形式がサポートされています。

定義を追加するには:

1. 左側のメニューで [資産] > [API] > 自分の API (Conference API) を選びます。
2. [詳細] を展開して、[バージョン] を選びます。
3. バージョン (v1) を選んで、[詳細] を展開します。
4. [詳細] で、[定義] > [定義の追加] を選びます。

Visual Studio Code 用の Azure API Center 拡張機能を使って、API を API インスタンスに登録できます。

ステップ 1:拡張機能をインストールする

ステップ 2: コマンド パレットを開き (Ctrl + Shift + P キー)、「API Center: Register API」と入力します

プロンプトに従って、API に関する次の情報を指定します。

API Center 拡張機能のタブを更新すると、新しく作成した API がそれぞれの APIC インスタンスとリソースに表示されます。

次のコマンドを使用して次の値を渡し、新しい API を作成します。

• -g: リソース グループ。例: Contoso
• -n: API センター サービス名。例: contoso-api-center
• --title: タイトル。例: Conference API
• --api-id: API ID。例: conference-api
• --type: 種類。例: REST

az apic api create -g contoso -n contoso-apis --title "Conference API" --api-id conference-api --type REST

次のコマンドを使用して次の値を渡し、API のバージョンを作成します。

• -g: リソース グループ。例: contoso
• -n: API センター サービス名。例: contoso-apis
• --api-id: API ID。例: conference-api
• --title: タイトル。例: v1.2.2
• --version-id: バージョン ID。例: 2024-07-03
• --lifecycle-stage: ライフサイクル ステージ。例: デザイン

az apic api version create -g contoso -n contoso-apis --api-id conference-api --title v1.2.2 --version-id 2024-07-03 --lifecycle-stage design

API バージョンの API 定義を追加することもできます。API Center では、OpenAPI 2 や REST 用の OpenAPI 3 などのテキスト指定形式がサポートされています。

定義を追加するには、次のコマンドを使用して次の値を渡します。

• -g: リソース グループ。例: contoso
• -n: API センター サービス名。例: contoso-apis
• --api-id: API ID。例: conference-api
• --version-id: バージョン ID。例: 2024-07-03
• --title: タイトル。例: OpenAPI
• --definition-id: 定義 ID。例: openapi

az apic api definition create -g contoso -n contoso-apis --api-id conference-api --version-id 2024-07-03 --title OpenAPI --definition-id openapi 

URL から OpenAPI 定義ファイルをインポートするには、az apic api definition import-specification コマンドを使ってインポートします。 例: https://conferenceapi.azurewebsites.net/?format=json

az apic api definition import-specification -g contoso -n contoso-apis --api-id conference-api --version-id 2024-07-03 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.2"}'

環境を作成するには:

1. 左側のメニューで、[資産] > [環境] > [+ 新しい環境] を選びます。

2. 次の情報を入力します。

3. ［作成］ を選択します

4. "運用環境" に対して同じ手順を繰り返します。

   

環境を作成するには、次の CLI コマンドを実行します。

az apic environment create -g contoso -n contoso-apis --title ContosoTesting --environment-id contosotesting --type testing

運用環境に対して同じ手順を繰り返します

az apic environment create -g contoso -n contoso-apis-new --title ContosoProduction --environment-id contosoproduction --type production

1. ポータルで、API Center に移動します。

2. 左側のメニューで [API] を選んでから、API を選びます (Conference API など)。

3. [Conference API] ページで、[詳細] > [デプロイ] > [+ デプロイの追加] を展開します。

4. 以下の情報を追加します。

   a. [環境] フィールドのドロップダウンから Contoso Testing を選びます。

   b. [定義] の [選択] をクリックし、ドロップダウンから API のバージョン v1 を選んで、前に追加した定義を選びます。 [選択] をクリックします。

   c. 定義が正常に追加されたら、選んだ環境の API に固有の基本ランタイム URL を追加します。

   

デプロイを作成し、上記の手順で作成した環境に関連付けるには、次の CLI コマンドを実行します。

az apic api deployment create -g contoso-corporation -s contoso-api-center --deployment-id "v1-conference-api" --title "Conference OpenAPI 2" --description "Conference Demo API deployment." --api-id conference-api --environment-id "/workspaces/default/environments/contoso-testing" --definition-id "/workspaces/default/apis/conference-api/versions/v1/definitions/conference-openapi-2" --server '{"runtimeUri":["https://conferenceapi.azurewebsites.net/"]}'