将开发代理与 SharePoint 框架 （SPFx） 解决方案配合使用

SharePoint 框架（SPFx）是用于扩展 SharePoint、Microsoft Teams、Microsoft Viva 和 Microsoft 365 的开发模型。 生成 SPFx 解决方案时，可以使用开发代理截获解决方案发出的 Web 请求，并查看它如何处理 API 错误。

截获 SPFx 解决方案发出的 Web 请求

SharePoint 框架解决方案是在 Web 浏览器中运行的客户端应用程序。 在启动开发代理之前，需要将其配置为截获 SPFx 解决方案发出的请求。 通常，你想要截获Microsoft Graph 和 SharePoint REST API 的请求。 如果使用自定义 API，则还需要截获对这些 API 的请求。 可以定义要在开发代理配置文件中的属性中截获的 urlsToWatch URL。

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

提示

将开发代理与SharePoint 框架开发代理解决方案配合使用时，请使用示例解决方案库中的 SPFx 预设。 它包含用于截获 SPFx 解决方案发出的 Web 请求的常见配置，包括对 Microsoft Graph 和 SharePoint REST API 的请求。

在计算机上启动开发代理时，它会自动截获 SPFx 解决方案发出的 Web 请求，并模拟配置的响应。 无需更改 SPFx 解决方案以使用开发代理。

将开发代理配置为不截获SharePoint 框架工作台请求

生成 SPFx 解决方案时，可以使用 SharePoint 框架 工作台来测试 Web 部件。 SharePoint 框架工作台在 Web 浏览器中运行，并使用 SharePoint API 加载 Web 部件。 默认情况下，开发代理会截获来自 Web 浏览器的所有 Web 请求，包括SharePoint 框架工作台发出的请求。 因此，它可以防止测试 Web 部件。

为了避免开发代理阻止SharePoint 框架工作台发出的请求，请将开发代理配置为不截获对 Web 部件 API 的请求。 在开发代理配置文件中，通过更新 urlsToWatch 属性排除 API。

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

提示

如果使用示例解决方案库中的 SPFx 预设，则它已从开发代理截获此 URL 中排除。