Compartir a través de

Usar proxy de desarrollo con soluciones de SharePoint Framework (SPFx)

  • Artículo

SharePoint Framework (SPFx) es un modelo de desarrollo para extender SharePoint, Microsoft Teams, Microsoft Viva y Microsoft 365. Al compilar soluciones SPFx, puede usar Dev Proxy para interceptar las solicitudes web realizadas por la solución y ver cómo controla los errores de API.

Interceptación de solicitudes web realizadas por la solución SPFx

Las soluciones de SharePoint Framework son aplicaciones del lado cliente que se ejecutan en el explorador web. Antes de iniciar el proxy de desarrollo, debe configurarlo para interceptar las solicitudes realizadas por la solución SPFx. A menudo, quiere interceptar solicitudes a las API rest de Microsoft Graph y SharePoint. Si usa API personalizadas, también quiere interceptar las solicitudes a ellas. Puede definir las direcciones URL que se van a interceptar en la urlsToWatch propiedad en el archivo de configuración del proxy de desarrollo.

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

Sugerencia

Al usar el proxy de desarrollo con soluciones de proxy de desarrollo de SharePoint Framework, use el valor preestablecido spFx de la Galería de soluciones de ejemplo. Contiene la configuración común para interceptar solicitudes web realizadas por soluciones SPFx, incluidas las solicitudes a las API rest de Microsoft Graph y SharePoint.

Al iniciar el proxy de desarrollo en el equipo, intercepta automáticamente las solicitudes web realizadas por la solución SPFx y simula respuestas configuradas. No es necesario cambiar la solución SPFx para usar el proxy de desarrollo.

Configurar el proxy de desarrollo para no interceptar solicitudes de área de trabajo de SharePoint Framework

Al compilar soluciones SPFx, use el área de trabajo de SharePoint Framework para probar los elementos web. SharePoint Framework workbench se ejecuta en el explorador web y usa las API de SharePoint para cargar elementos web. De forma predeterminada, el proxy de desarrollo intercepta todas las solicitudes web del explorador web, incluidas las solicitudes realizadas por el área de trabajo de SharePoint Framework. Como resultado, puede impedir que pruebe los elementos web.

Para evitar que el proxy de desarrollo bloquee las solicitudes realizadas por el área de trabajo de SharePoint Framework, configure proxy de desarrollo para no interceptar las solicitudes a la API del elemento web. En el archivo de configuración del proxy de desarrollo, excluya la API actualizando la urlsToWatch propiedad .

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

Sugerencia

Si usa el valor preestablecido de SPFx de la Galería de soluciones de ejemplo, ya excluye esta dirección URL de la interceptación del proxy de desarrollo.