OpenAPI 仕様のインポート

適用対象: すべての API Management レベル

この記事では、 https://conferenceapi.azurewebsites.net?format=jsonに存在する "OpenAPI の仕様" のバックエンド API をインポートする方法を示します。 このバックエンド API は Microsoft によって提供され、Azure でホストされています。 また、APIM API をテストする方法についても説明します。

この記事では、次のことについて説明します。

• Azure portal、Azure CLI、または Azure PowerShell を使用して OpenAPI 仕様をインポートする
• Azure Portal での API のテスト

Note

API インポートの制限については、 API インポートの制限事項と既知の問題に関するページをご覧ください。

前提条件

• API Management インスタンス。 本サービスをまだお持ちでない場合は、Azure API Management インスタンスの作成に関するクイックスタートを完了します。

• Azure CLI

  • Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。

    

  • CLI リファレンス コマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。

    • ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、Azure CLI でのサインインに関するページを参照してください。

    • 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。 拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。

    • az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。

• Azure PowerShell

  • Azure PowerShell をローカルで使用する場合は、次のようにします。
    • Az PowerShell モジュールの最新バージョンをインストールします。
    • Connect-AzAccount コマンドレットを使用して、Azure アカウントに接続します。
  • Azure Cloud Shell を使用する場合は、次のようにします。
    • 詳細については、Azure Cloud Shell の概要に関するページを参照してください。

バックエンド API をインポートする

ポータル

1. Azure portal で、API Management インスタンスに移動します。

2. 左側のメニューで、 [API]>[+ API の追加] を選択します。

3. [Create from definition](定義から作成) で、[OpenAPI] を選択します。

   

4. API 設定を入力します。 値は、作成時に設定することも、後で [設定] タブに移動して構成することもできます。設定については、「最初の API のインポートと発行」のチュートリアルで説明されています。

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

Azure CLI

次の例では、 az apim api import コマンドを使用して、指定した URL から apim-hello-worldという名前の API Management インスタンスに OpenAPI 仕様をインポートします。 URL の代わりに仕様へのパスを使用してインポートするには、 --specification-path パラメーターを使用します。

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="demo-conference-api"
APIPath="conference"
SpecificationFormat="OpenAPI"
SpecificationURL="https://conferenceapi.azurewebsites.net/?format=json"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL

API をインポートした後、必要に応じて、 az apim api update コマンドを使用して設定を更新できます。

PowerShell

次の例では、 Import-AzApiManagementApi Azure PowerShell コマンドレットを使用して、指定した URL から apim-hello-worldという名前の API Management インスタンスに OpenAPI 仕様をインポートします。 URL の代わりに仕様へのパスを使用してインポートするには、 -SpecificationPath パラメーターを使用します。

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "demo-conference-api"
$apiPath = "conference"
$specificationFormat = "OpenAPI"
$specificationUrl = "https://conferenceapi.azurewebsites.net/?format=json"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

API をインポートした後、必要に応じて Set-AzApiManagementApi コマンドレットを使用して設定を更新できます。

ポータルでの新しい API のテスト

ポータルには、管理者が API の操作を表示およびテストするための便利な環境が用意されており、操作を直接呼び出すことができます。

1. 前の手順で作成した API を選びます。

2. [テスト] タブを選びます。

3. 操作を選択します。 ページに、クエリ パラメーターのフィールドとヘッダーのフィールドが表示されます。

   注意

   テスト コンソールでは、API Management によって Ocp-Apim-Subscription-Key ヘッダーが自動的に設定され、組み込みの オール アクセス サブスクリプションのサブスクリプション キーが構成されます。 このキーを使用すると、API Management インスタンス内のすべての API にアクセスできます。 必要に応じて、 HTTP 要求の横にある "目" のアイコンを選択して、 Ocp-Apim-Subscription-Key ヘッダーを表示します。

4. 操作に応じて、クエリ パラメーター値、ヘッダー値、または要求本文を入力します。 [Send] を選択します。

   テストが成功すると、バックエンドは成功した HTTP 応答コードと一部のデータで応答します。

   ヒント

   既定では、テスト コンソールから API Management の CORS プロキシに要求が送信され、要求が API Management インスタンスに転送され、バックエンドに転送されます。 このプロキシはパブリック IP アドレス 13.91.254.72 を使用し、パブリック エンドポイントにのみ到達できます。 ブラウザーから API Management サービスに直接要求を送信する場合は、[CORS プロキシのバイパス] を選択します。 このオプションは、テスト コンソールを使用する場合に、API Management ゲートウェイがネットワーク分離されているか、CORS プロキシからのトラフィックを許可しない場合に使用します。

API をデバッグするには、「 チュートリアル:要求トレースを使用して API をデバッグする」をご覧ください。

その他の API の追加

次のように、各種サービスで公開される API を構成できます。

• OpenAPI の仕様
• SOAP API
• GraphQL API
• Azure App Service でホストされる Web アプリ
• Azure Function App
• Azure Logic Apps
• Azure Service Fabric

次の手順に従って、既存の API に別の API を追加します。

Note

別の API をインポートすると、操作が現在の API に追加されます。

1. Azure portal で Azure API Management インスタンスに移動します。

   

2. [概要] ページまたは左側のメニューから [API] を選択します。

   

3. 別の API を追加する API の隣の [...] をクリックします。

4. ドロップダウン メニューから [インポート] を選択します。

   

5. API のインポート元のサービスを選択します。

   

関連トピック

• API のインポートの制限事項
• OpenAPI 仕様のインポート
• SOAP API のインポート
• SOAP API のインポートと REST への変換
• App Service API をインポートする
• コンテナー アプリ API をインポートする
• Websocket API のインポート
• GraphQL API のインポート
• GraphQL スキーマをインポートし、フィールド リゾルバーを設定する
• Azure 関数アプリをインポートする
• Azure ロジック アプリをインポートする
• Service Fabric サービスをインポートする
• OData API をインポートする
• SAP OData メタデータをインポートする
• gRPC API をインポートする
• API の編集

OpenAPI 仕様に対して検証する

OpenAPI 仕様のスキーマに対して要求と応答 (またはそれらの要素) を検証するように、API Management 検証ポリシーを構成できます。 たとえば、validate-content ポリシーを使用して、要求または応答の本文のサイズまたはコンテンツを検証します。

次のステップ

• 成果物を作成して発行する
• 公開された API の変換と保護