Utiliser le proxy de développement avec des solutions SharePoint Framework (SPFx)

SharePoint Framework (SPFx) est un modèle de développement pour étendre SharePoint, Microsoft Teams, Microsoft Viva et Microsoft 365. Lorsque vous générez des solutions SPFx, vous pouvez utiliser le proxy de développement pour intercepter les requêtes web effectuées par votre solution et voir comment elle gère les erreurs d’API.

Intercepter les demandes web effectuées par votre solution SPFx

Les solutions SharePoint Framework sont des applications côté client qui s’exécutent dans le navigateur web. Avant de démarrer le proxy de développement, vous devez le configurer pour intercepter les demandes effectuées par votre solution SPFx. Souvent, vous souhaitez intercepter les requêtes aux API REST Microsoft Graph et SharePoint. Si vous utilisez des API personnalisées, vous souhaitez également intercepter les requêtes. Vous pouvez définir les URL à intercepter dans la propriété dans le urlsToWatch fichier de configuration du proxy de développement.

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

Conseil

Lorsque vous utilisez le proxy de développement avec des solutions de proxy de développement SharePoint Framework, utilisez la présélection SPFx à partir de l’exemple de galerie de solutions. Il contient la configuration courante pour intercepter les demandes web effectuées par des solutions SPFx, y compris les demandes adressées aux API REST Microsoft Graph et SharePoint.

Lorsque vous démarrez le proxy de développement sur votre ordinateur, il intercepte automatiquement les requêtes web effectuées par votre solution SPFx et simule les réponses configurées. Vous n’avez pas besoin de modifier votre solution SPFx pour utiliser le proxy de développement.

Configurer le proxy de développement pour ne pas intercepter les requêtes Workbench SharePoint Framework

Lors de la création de solutions SPFx, vous utilisez SharePoint Framework workbench pour tester vos composants WebPart. SharePoint Framework workbench s’exécute dans le navigateur web et utilise des API SharePoint pour charger des composants WebPart. Par défaut, le proxy de développement intercepte toutes les requêtes web à partir de votre navigateur web, y compris les demandes effectuées par SharePoint Framework workbench. Par conséquent, il peut vous empêcher de tester vos composants WebPart.

Pour éviter que le proxy de développement bloque les requêtes effectuées par SharePoint Framework workbench, configurez le proxy de développement pour ne pas intercepter les requêtes adressées à l’API du composant WebPart. Dans votre fichier de configuration du proxy de développement, excluez l’API en mettant à jour la urlsToWatch propriété.

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

Conseil

Si vous utilisez la présélection SPFx à partir de l’exemple de galerie de solutions, elle exclut déjà cette URL d’être interceptée par le proxy de développement.