OData API をインポートする

  • [アーティクル]

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

この記事では、OData 準拠サービスを API として API Management にインポートする方法について説明します。

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

  • Azure portal を使用して OData メタデータの説明をインポートする
  • ポータルで OData スキーマを管理する
  • OData API をセキュリティで保護する

Note

OData サービスをそのメタデータの説明から API としてインポートする操作はプレビュー段階です。

前提条件

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

  • OData v2 または v4 として公開されているサービス。

API Management インスタンスに移動します。

  1. Azure portal で、[API Management サービス] を検索して選択します。

    [API Management サービス] を選択する

  2. [API Management サービス] ページで、ご自身の API Management インスタンスを選択します。

    API Management インスタンスを選択する

OData メタデータをインポートする

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

  2. [定義から作成] で [OData] を選択します。

    ポータルで OData の説明から API を作成しているスクリーンショット。

  3. API 設定を入力します。 API の [設定] タブに移動することで、後で設定を更新することができます。

    1. [OData 仕様]で、OData メタデータ エンドポイントの URL を入力します。これは通常、サービス ルートへの URL であり、/$metadata が追加されています。 または、インポートするローカルの OData XML ファイルを選択します。

    2. 残りの設定を入力して API を構成します。 設定については、「最初の API のインポートと発行」のチュートリアルで説明されています。

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

    API が [API] リストに追加されます。 OData メタデータの説明で公開されているエンティティ セットと関数が、API の [Entity sets and functions] (エンティティ セットと関数) タブに表示されます。

    ポータルの OData エンティティ セットと関数のスクリーンショット。

OData スキーマを更新する

ポータルでエディターにアクセスして、API の OData スキーマを表示できます。 API が変更された場合は、ファイルまたは OData サービス エンドポイントから API Management のスキーマを更新することもできます。

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

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

  3. [Entity sets and functions] (エンティティ セットと関数) タブで、エンティティ セットまたは関数の横にあるコンテキスト メニュー (...) を選択し、[編集] を選択します。

    ポータルの OData エンティティ セットのコンテキスト メニューのスクリーンショット。

  4. スキーマを確認します。 更新する場合は、[ファイルから更新する] または [エンドポイントからスキーマを更新する] を選択します。

    ポータルでの OData API スキーマ エディターのスクリーンショット。

OData API をテストする

  1. 左側のメニューで、[API]> OData API を選択します。

  2. [Entity sets and functions] (エンティティ セットと関数) タブで、エンティティ セットまたは関数の横にあるコンテキスト メニュー (...) を選択し、[テスト] を選択します。

    ポータルの OData エンティティ セットのコンテキスト メニューの [テスト] オプションのスクリーンショット。

  3. テスト コンソールで、テストのテンプレート パラメーター、クエリ パラメーター、ヘッダーを入力し、[テスト] を選択します。 ポータルでの API のテストの詳細について説明します。

OData API をセキュリティで保護する

OData API 要求を介した攻撃から保護するために、既存の認証ポリシーと承認ポリシーと OData 検証ポリシー の両方を適用して、OData API をセキュリティで保護します。

ヒント

ポータルの [API ポリシー] タブで、OData 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 インスタンスに移動します。

    Azure API Management インスタンスに移動する

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

    [API] を選択する

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

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

    [インポート] を選択する

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

    サービスを選択する