Delen via

Dev Proxy gebruiken met SPFx-oplossingen (SharePoint Framework)

  • Artikel

SharePoint Framework (SPFx) is een ontwikkelingsmodel voor het uitbreiden van SharePoint, Microsoft Teams, Microsoft Viva en Microsoft 365. Wanneer u SPFx-oplossingen bouwt, kunt u Dev Proxy gebruiken om webaanvragen van uw oplossing te onderscheppen en te zien hoe API-fouten worden verwerkt.

Webaanvragen onderscheppen die zijn gedaan door uw SPFx-oplossing

SharePoint Framework-oplossingen zijn toepassingen aan de clientzijde die worden uitgevoerd in de webbrowser. Voordat u Dev Proxy start, moet u deze configureren om aanvragen van uw SPFx-oplossing te onderscheppen. Vaak wilt u aanvragen onderscheppen voor Microsoft Graph- en SharePoint REST API's. Als u aangepaste API's gebruikt, wilt u ook aanvragen voor hen onderscheppen. U kunt de URL's definiëren die moeten worden onderschept in de urlsToWatch eigenschap in het configuratiebestand dev proxy.

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

Tip

Wanneer u Dev Proxy met SharePoint Framework Dev Proxy-oplossingen gebruikt, gebruikt u de vooraf ingestelde SPFx in de galerie met voorbeeldoplossingen. Het bevat de algemene configuratie voor het onderscheppen van webaanvragen die zijn gedaan door SPFx-oplossingen, waaronder aanvragen voor Microsoft Graph en SharePoint REST API's.

Wanneer u Dev Proxy op uw computer start, worden webaanvragen die zijn gedaan door uw SPFx-oplossing automatisch onderschept en geconfigureerde antwoorden gesimuleerd. U hoeft uw SPFx-oplossing niet te wijzigen om Dev Proxy te gebruiken.

Dev Proxy configureren om Workbench-aanvragen van SharePoint Framework niet te onderscheppen

Bij het bouwen van SPFx-oplossingen gebruikt u sharePoint Framework workbench om uw webonderdelen te testen. SharePoint Framework workbench wordt uitgevoerd in de webbrowser en gebruikt SharePoint-API's om webonderdelen te laden. Standaard onderschept Dev Proxy alle webaanvragen vanuit uw webbrowser, inclusief de aanvragen die door de SharePoint Framework workbench zijn gedaan. Hierdoor kunt u voorkomen dat u uw webonderdelen test.

Als u wilt voorkomen dat Dev Proxy de aanvragen blokkeert die door de SharePoint Framework Workbench worden gedaan, configureert u Dev Proxy om aanvragen niet te onderscheppen naar de webonderdeel-API. Sluit de API uit in uw Dev Proxy-configuratiebestand door de eigenschap bij te urlsToWatch werken.

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

Tip

Als u de vooraf ingestelde SPFx uit de voorbeeldoplossingsgalerie gebruikt, wordt deze URL al onderschept door Dev Proxy.