Usare Dev Proxy con soluzioni SharePoint Framework (SPFx)

SharePoint Framework (SPFx) è un modello di sviluppo per estendere SharePoint, Microsoft Teams, Microsoft Viva e Microsoft 365. Quando si compilano soluzioni SPFx, è possibile usare Dev Proxy per intercettare le richieste Web effettuate dalla soluzione e vedere come gestisce gli errori dell'API.

Intercettare le richieste Web effettuate dalla soluzione SPFx

SharePoint Framework soluzioni sono applicazioni lato client eseguite nel Web browser. Prima di avviare Dev Proxy, è necessario configurarlo per intercettare le richieste effettuate dalla soluzione SPFx. Spesso si vuole intercettare le richieste alle API REST di Microsoft Graph e SharePoint. Se si usano API personalizzate, si desidera intercettare anche le richieste. È possibile definire gli URL da intercettare nella urlsToWatch proprietà nel file di configurazione di Dev Proxy.

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

Suggerimento

Quando si usa Dev Proxy con SharePoint Framework soluzioni Dev Proxy, usare il set di impostazioni SPFx dalla Raccolta soluzioni di esempio. Contiene la configurazione comune per intercettare le richieste Web effettuate dalle soluzioni SPFx, incluse le richieste alle API REST di Microsoft Graph e SharePoint.

Quando si avvia Dev Proxy nel computer, intercetta automaticamente le richieste Web effettuate dalla soluzione SPFx e simula le risposte configurate. Non è necessario modificare la soluzione SPFx per usare Dev Proxy.

Configurare Dev Proxy per non intercettare le richieste di workbench SharePoint Framework

Quando si creano soluzioni SPFx, è possibile usare il workbench di SharePoint Framework per testare le web part. SharePoint Framework workbench viene eseguito nel Web browser e usa le API di SharePoint per caricare web part. Per impostazione predefinita, Dev Proxy intercetta tutte le richieste Web dal Web browser, incluse le richieste effettuate dal SharePoint Framework workbench. Di conseguenza, può impedire di testare le web part.

Per evitare il blocco delle richieste effettuate dal SharePoint Framework workbench, configurare Dev Proxy per non intercettare le richieste all'API della web part. Nel file di configurazione di Dev Proxy escludere l'API aggiornando la urlsToWatch proprietà.

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

Suggerimento

Se si usa il set di impostazioni SPFx dalla Raccolta soluzioni di esempio, l'URL viene già escluso dall'intercetta da Dev Proxy.