Azure Logic Apps のワークフローから独自の Web API と REST API を呼び出す

適用対象: Azure Logic Apps (従量課金 + 標準)

Azure Logic Apps のワークフローから呼び出す既存の Web API または REST API がある場合は、これらの API を呼び出す前に、まずいくつかのセットアップ手順を完了する必要があります。 主に、API を Web アプリまたは API アプリとしてデプロイする必要があります。 このタスクを実行するには、高度にスケーラブルで簡単な API ホスティングを提供するクラウド プラットフォームである Azure App Service で API をホストします。

App Service では、API を Web アプリとしてデプロイできますが、API を API アプリとしてデプロイすることを検討してください。 この方法を使用すると、クラウド環境とオンプレミス環境で API を構築、ホスト、使用する際の作業が簡単になります。 API アプリにデプロイするために API のコードを変更する必要はありません。

ワークフローから任意の API を呼び出すことができますが、最適なエクスペリエンスを得るために、Web アプリまたは API アプリに Swagger メタデータ を追加します。 この Swagger ドキュメントでは、API の操作とパラメーターについて説明します。これは、ロジック アプリワークフローが API でより適切かつ簡単に動作するのに役立ちます。 また、ワークフローが API にアクセスできるように、Web アプリまたは API アプリでクロスオリジン リソース共有 (CORS) を設定する必要があります。

このガイドでは、Swagger ドキュメントを追加する方法、Web アプリまたは API アプリの CORS を設定する方法、App Service で API のデプロイとホスティングを完了した後にワークフローから API を呼び出すためのオプションを提供する方法について説明します。

詳細については、以下を参照してください。

• Azure App Service
• ASP.NET Web アプリを作成してデプロイする
• Azure App Service で CORS を使用して RESTful API をホストする

[前提条件]

• アクティブなサブスクリプションを持つ Azure アカウント。 サブスクリプションがない場合は、無料アカウントを作成してください。

• Azure Logic Apps のワークフローと互換性があり、Web アプリまたは API アプリとして App Service にデプロイされるパターンの 1 つに従う Web API または REST API。

  詳細については、以下を参照してください。

  • ASP.NET Web アプリを作成してデプロイする
  • Azure App Service で CORS を使用して RESTful API をホストする

Web アプリまたは API アプリに Swagger と CORS アクセスを追加する

Web アプリまたは API アプリに Swagger ドキュメントを追加すると、Azure Logic Apps のワークフロー デザイナーは、API で使用可能な操作とパラメーターをより簡単に見つけて表示できます。 また、ワークフローが API にアクセスできるように、Web アプリまたは API アプリでクロスオリジン リソース共有 (CORS) を設定する必要があります。

Swagger ドキュメントをデザイナーのワークフローから読み取り可能にするには、Web アプリまたは API アプリで、API 定義のプロパティと CORS アクセスを設定します。

1. Azure portal で、Web アプリまたは API アプリ リソースを見つけて開きます。

2. アプリ リソースサイドバーで、[ 概要] を選択します。

3. [ プロパティ ] タブの [ ドメイン] の下の [既定のドメイン ] プロパティから、次の手順のために Web サイト名をコピーしてどこかに保存します。

4. アプリ リソースサイドバーの [ API] で、[ API 定義] を選択します。 API 定義の場所については、Swagger JSON ファイルの URL を入力します。これは通常、次の形式を使用しますが、Swagger ファイルで新しい API 仕様が使用されている場合は異なる場合があります。

   https://<website-name>/swagger/docs/v1

   次の例は、新しい API 仕様の Swagger URL を示しています。

   

5. 完了したら、[保存] を選択します。

6. アプリ リソースサイドバーの [API] で、[ CORS] を選択します。

7. 許可される配信元の場合は、CORS ポリシーを '*' に設定します。これは、すべて許可することを意味します。

   この設定により、Azure Logic Apps のワークフロー デザイナーからの要求が許可されます。

   

8. ツール バーで、保存を選択します。

詳細については、「 Azure App Service で CORS を使用して RESTful API をホストする」を参照してください。

ワークフローから API を呼び出す

API 定義 URL と CORS を設定すると、API 操作がコネクタギャラリーに表示され、これを見つけてワークフローに追加できます。

• OpenAPI URL を持つ Web サイトを表示するには、ワークフロー デザイナーでサブスクリプション Web サイトを参照します。

• Swagger ドキュメントをポイントして使用可能なアクションと入力を表示するには、 HTTP + Swagger トリガーまたはアクションを使用します。

• Swagger ドキュメントを持たない API や公開していない API など、API を呼び出すには、 HTTP アクションを使用していつでも要求を作成できます。

関連コンテンツ

• Azure Logic Apps のカスタム コネクタ