次の方法で共有

OData API をインポートする

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

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

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

  • Azure portal を使用して OData メタデータの説明をインポートする
  • ポータルで OData スキーマを管理する
  • 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 サービス] ページの API Management インスタンスを示すスクリーンショット。

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

  1. 左側のメニューで、API>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. [ エンティティ セットと関数 ] タブで、エンティティ セットまたは関数の横にある省略記号 (...) を選択し、[ 編集] を選択します。

    [編集] コマンドの場所を示すスクリーンショット。

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

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

OData API をテストする

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

  2. [ エンティティ セットと関数 ] タブで、エンティティ セットまたは関数の横にある省略記号 (...) を選択し、[ テスト] を選択します。

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

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

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

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

ヒント

ポータルの [API ポリシー] タブで、OData API のポリシーを 構成します。

その他の API の追加

次のようなさまざまなサービスによって公開された API の中から任意の API を構成できます。

  • OpenAPI の仕様
  • SOAP API（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 のインポート元のサービスを選択します。

関連コンテンツ