Usar o Dev Proxy com soluções SPFx do SharePoint

O SharePoint Framework (SPFx) é um modelo de desenvolvimento para estender o SharePoint, Microsoft Teams, Microsoft Viva e Microsoft 365. Ao criar soluções SPFx, você pode usar o Dev Proxy para intercetar solicitações da Web feitas pela sua solução e ver como ela lida com erros de API.

Intercete solicitações da Web feitas pela sua solução SPFx

As soluções da Estrutura do SharePoint são aplicativos do lado do cliente que são executados no navegador da Web. Antes de iniciar o Dev Proxy, você precisa configurá-lo para intercetar solicitações feitas pela sua solução SPFx. Muitas vezes, você deseja intercetar solicitações para APIs REST do Microsoft Graph e do SharePoint. Se você usa APIs personalizadas, também deseja intercetar solicitações para elas. Você pode definir as URLs a serem intercetadas na urlsToWatch propriedade no arquivo de configuração do Dev Proxy.

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

Gorjeta

Ao usar o Proxy de Desenvolvimento com soluções da Estrutura do SharePoint, utilize a predefinição SPFx da Galeria de Soluções de Exemplo. Ele contém a configuração comum para intercetar solicitações da Web feitas por soluções SPFx, incluindo solicitações para APIs REST do Microsoft Graph e do SharePoint.

Quando você inicia o Dev Proxy em sua máquina, ele interceta automaticamente as solicitações da Web feitas pela sua solução SPFx e simula as respostas configuradas. Você não precisa alterar sua solução SPFx para usar o Dev Proxy.

Configurar o Proxy de Desenvolvimento para não interceptar solicitações do workbench do SharePoint Framework

Ao criar soluções SPFx, você usa o workbench da Estrutura do SharePoint para testar suas Web Parts. O workbench do SharePoint Framework é executado no navegador da Web e usa APIs do SharePoint para carregar Web Parts. Por padrão, o Dev Proxy intercepta todas as solicitações da Web do seu navegador, incluindo as solicitações feitas pelo workbench do Framework do SharePoint. Como resultado, isso pode impedir-te de testar os teus componentes Web.

Para evitar que o Proxy de Desenvolvimento bloqueie as solicitações feitas pelo workbench do Framework do SharePoint, configure o Proxy de Desenvolvimento para não interceptar solicitações para a API da Web Part. No arquivo de configuração do Proxy de Desenvolvimento, exclua a API atualizando a urlsToWatch propriedade.

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

Gorjeta

Se usar a configuração padrão SPFx da Galeria de Soluções de Exemplo, ela já exclui essa URL de ser intercetada pelo Dev Proxy.