Freigeben über

Verwenden von Dev Proxy mit SharePoint-Framework (SPFx)-Lösungen

  • Artikel

SharePoint-Framework (SPFx) ist ein Entwicklungsmodell zur Erweiterung von SharePoint, Microsoft Teams, Microsoft Viva und Microsoft 365. Wenn Sie SPFx-Lösungen erstellen, können Sie Dev Proxy verwenden, um von Ihrer Lösung vorgenommene Webanforderungen abzufangen und zu sehen, wie API-Fehler behandelt werden.

Abfangen von Webanforderungen, die von Ihrer SPFx-Lösung vorgenommen werden

SharePoint-Framework Lösungen sind clientseitige Anwendungen, die im Webbrowser ausgeführt werden. Bevor Sie Dev Proxy starten, müssen Sie ihn so konfigurieren, dass Anforderungen von Ihrer SPFx-Lösung abgefangen werden. Häufig möchten Sie Anforderungen an Microsoft Graph und SharePoint-REST-APIs abfangen. Wenn Sie benutzerdefinierte APIs verwenden, möchten Sie auch Anforderungen an sie abfangen. Sie können die URLs definieren, die in der Eigenschaft in der urlsToWatch Dev Proxy-Konfigurationsdatei abgefangen werden sollen.

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

Tipp

Wenn Sie Dev Proxy mit SharePoint-Framework Dev Proxy-Lösungen verwenden, verwenden Sie die SPFx-Voreinstellung aus dem Beispiellösungskatalog. Sie enthält die allgemeine Konfiguration zum Abfangen von Webanforderungen von SPFx-Lösungen, einschließlich Anforderungen an Microsoft Graph und SharePoint-REST-APIs.

Wenn Sie Dev Proxy auf Ihrem Computer starten, werden webanforderungen von Ihrer SPFx-Lösung automatisch abgefangen und konfigurierte Antworten simuliert. Sie müssen Ihre SPFx-Lösung nicht ändern, um Dev Proxy zu verwenden.

Konfigurieren von Dev Proxy, um SharePoint-Framework Workbench-Anforderungen nicht abzufangen

Beim Erstellen von SPFx-Lösungen verwenden Sie die SharePoint-Framework Workbench, um Ihre Webparts zu testen. SharePoint-Framework Workbench wird im Webbrowser ausgeführt und verwendet SharePoint-APIs zum Laden von Webparts. Standardmäßig fängt Dev Proxy alle Webanforderungen von Ihrem Webbrowser ab, einschließlich der Anforderungen der SharePoint-Framework Workbench. Dadurch kann verhindert werden, dass Sie Ihre Webparts testen.

Um zu verhindern, dass Dev Proxy die Anforderungen der SharePoint-Framework Workbench blockiert, konfigurieren Sie Dev Proxy, um Anforderungen an die Webpart-API nicht abzufangen. Schließen Sie in Ihrer Dev Proxy-Konfigurationsdatei die API aus, indem Sie die urlsToWatch Eigenschaft aktualisieren.

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

Tipp

Wenn Sie die SPFx-Voreinstellung aus dem Beispiellösungskatalog verwenden, schließt sie diese URL bereits vom Dev-Proxy abfangen.