SharePoint Framework (SPFx) ソリューションで開発プロキシを使用する

SharePoint Framework (SPFx) は、SharePoint、Microsoft Teams、Microsoft Viva、Microsoft 365 を拡張するための開発モデルです。 SPFx ソリューションをビルドするときに、開発プロキシを使用して、ソリューションによって行われた Web 要求をインターセプトし、API エラーの処理方法を確認できます。

SPFx ソリューションによって行われた Web 要求をインターセプトする

SharePoint Framework ソリューションは、Web ブラウザーで実行されるクライアント側アプリケーションです。 開発プロキシを開始する前に、SPFx ソリューションによって行われた要求をインターセプトするように構成する必要があります。 多くの場合、Microsoft Graph および SharePoint REST API への要求をインターセプトする必要があります。 カスタム API を使用する場合は、それらに対する要求もインターセプトする必要があります。 開発プロキシ構成ファイルの urlsToWatch プロパティでインターセプトする URL を定義できます。

{
  // [...] trimmed for brevity
  "urlsToWatch": [
    "https://graph.microsoft.com/*",
    "https://*.sharepoint.com/*"
    // other URLs to watch
  ]
}

ヒント

SharePoint Framework 開発プロキシ ソリューションで開発プロキシを使用する場合は、サンプル ソリューション ギャラリーの SPFx プリセット を使用します。 これには、Microsoft Graph および SharePoint REST API への要求など、SPFx ソリューションによって行われた Web 要求をインターセプトするための一般的な構成が含まれています。

コンピューターで開発プロキシを起動すると、SPFx ソリューションによって行われた Web 要求が自動的にインターセプトされ、構成された応答がシミュレートされます。 開発プロキシを使用するように SPFx ソリューションを変更する必要はありません。

SharePoint Framework ワークベンチの要求をインターセプトしないように開発プロキシを構成する

SPFx ソリューションをビルドするときは、SharePoint Framework ワークベンチを使用して Web パーツをテストします。 SharePoint Framework ワークベンチは Web ブラウザーで実行され、SharePoint API を使用して Web パーツを読み込みます。 既定では、開発プロキシは、SharePoint Framework ワークベンチによって行われた要求を含め、Web ブラウザーからのすべての Web 要求をインターセプトします。 その結果、Web パーツをテストできなくなる可能性があります。

開発プロキシが SharePoint Framework ワークベンチによって行われた要求をブロックしないようにするには、Web パーツ API への要求をインターセプトしないように開発プロキシを構成します。 開発プロキシ構成ファイルで、 urlsToWatch プロパティを更新して API を除外します。

{
  // [...] trimmed for brevity
  "urlsToWatch": [
    "!https://*.sharepoint.com/_api/web/GetClientSideComponents*"
    // other URLs to watch
  ]
}

ヒント

サンプル ソリューション ギャラリーから SPFx プリセットを使用する場合、この URL は開発プロキシによってインターセプトされないように既に除外されています。