Usar o Proxy de Desenvolvimento com soluções SPFx (Estrutura do SharePoint)

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

Intercepte solicitações da Web feitas por sua solução SPFx

As soluções da Estrutura do SharePoint são aplicativos do lado do cliente executados no navegador da Web. Antes de iniciar o Dev Proxy, você precisa configurá-lo para interceptar solicitações feitas por sua solução SPFx. Muitas vezes, você deseja interceptar solicitações para APIs REST do Microsoft Graph e do SharePoint. Se você usa APIs personalizadas, também deseja interceptar solicitações para elas. Você pode definir as URLs a serem interceptadas 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
  ]
}

Dica

Ao usar o Proxy de Desenvolvimento com soluções de Proxy de Desenvolvimento da Estrutura do SharePoint, use a predefinição SPFx da Galeria de Soluções de Exemplo. Ele contém a configuração comum para interceptar 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 seu computador, ele intercepta automaticamente as solicitações da Web feitas por 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 de bancada da Estrutura do SharePoint

Ao criar soluções SPFx, você usa o workbench da Estrutura do SharePoint para testar suas Web Parts. O workbench da Estrutura do SharePoint é executado no navegador da Web e usa APIs do SharePoint para carregar Web Parts. Por padrão, o Proxy de Desenvolvimento intercepta todas as solicitações da Web do navegador da Web, incluindo as solicitações feitas pelo workbench da Estrutura do SharePoint. Como resultado, ele pode impedir que você teste suas Web Parts.

Para evitar que o Proxy de Desenvolvimento bloqueie as solicitações feitas pelo workbench da Estrutura 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
  ]
}

Dica

Se você usar a predefinição SPFx da Galeria de Soluções de Exemplo, ela já excluirá essa URL de ser interceptada pelo Proxy de Desenvolvimento.