次の方法で共有

OpenAPI 仕様のインポート

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

この記事では、さまざまなツールを使用して 、OpenAPI 仕様 バックエンド API を Azure API Management にインポートする方法について説明します。 また、API Management で API をテストする方法についても説明します。 OpenAPI バージョンのサポートについては、 API インポートの制限と既知の問題に関する説明を参照してください。

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

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

前提条件

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

この例では、オープン ソースの Petstore API の OpenAPI 仕様をインポートします。 任意の OpenAPI 仕様に置き換えることができます。

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

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

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

    ポータルで OpenAPI 仕様から API を作成するスクリーンショット。

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

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

OpenAPI 仕様の表示と編集

Azure portal で、OpenAPI 仕様エディターを使用して、インポートした API の仕様を表示、検証、または編集します。

OpenAPI 仕様エディターを使用するには、以下のようにします:

  1. Azure portal で、API Management インスタンスに移動します。
  2. 左側のメニューの [API] で、[API]><使用する API>>[すべての操作] を選択します。
  3. [デザイン] タブの [フロントエンド] で、OpenAPI 仕様エディター (鉛筆アイコン) 選択します。 仕様は JSON または YAML 形式で開くことができます。
  4. 仕様を確認し、必要に応じて編集します。 変更を保存します。

OpenAPI 仕様スキーマに対して検証する

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

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

Azure portal から直接操作を呼び出すことができます。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 の中から任意の API を構成できます。

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

注

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

既存の API に API を追加するには:

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

    [API Management サービス] ページを示すスクリーンショット。

  2. [概要] ページで [API] を選択するか、左側のメニューで [API]>[API] の順に選択します。

    [概要] ページでの [API] の選択を示すスクリーンショット。

  3. 別の API を追加する API の横にある省略記号 (...) を選択します。

  4. コンテキスト メニューから [インポート] を選択します。

    [インポート] コマンドを示すスクリーンショット。

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

関連コンテンツ

  • Last updated on