Использование прокси-сервера разработки с решениями SharePoint Framework (SPFx)

На первый взгляд
Цель: Использование прокси-сервера разработки с SharePoint Framework
Время: 10 минут
Плагины: Разные
Предварительные требования:Настройка прокси-сервера разработки, среды разработки SPFx

SharePoint Framework (SPFx) — это модель разработки для расширения SharePoint, Microsoft Teams, Microsoft Viva и Microsoft 365. При создании решений SPFx вы можете использовать прокси-сервер разработки для перехвата веб-запросов, сделанных решением, и узнать, как он обрабатывает ошибки API.

Перехватывать веб-запросы, отправляемые вашим решением SPFx

Решения SharePoint Framework — это клиентские приложения, которые выполняются в веб-браузере. Перед запуском прокси-сервера разработки необходимо настроить его для перехвата запросов, сделанных решением SPFx. Часто возникает необходимость перехватывать запросы к API Microsoft Graph и REST API SharePoint. Если вы используете пользовательские API, вы также хотите перехватывать запросы к ним. Вы можете определить URL-адреса для перехвата в свойстве urlsToWatch в файле конфигурации прокси-сервера разработки.

Файл: devproxyrc.json (раздел urlsToWatch)

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

Совет

При использовании Dev Proxy с решениями для разработки SharePoint Framework используйте предустановку SPFx из галереи примеров решений. Он содержит общую конфигурацию для перехвата веб-запросов, сделанных решениями SPFx, включая запросы к MICROSOFT Graph и REST API SharePoint.

При запуске прокси-сервера разработки на компьютере он автоматически перехватывает веб-запросы, сделанные решением SPFx, имитирует настроенные ответы. Вам не нужно изменять решение SPFx для использования Dev Proxy.

Настройка прокси-сервера разработки, чтобы не перехватывать запросы рабочей панели SharePoint Framework

При создании решений SPFx вы используете workbench SharePoint Framework для тестирования веб-частей. SharePoint Framework workbench выполняется в веб-браузере и использует API SharePoint для загрузки веб-частей. По умолчанию Dev Proxy перехватывает все веб-запросы из веб-браузера, включая запросы, сделанные рабочей средой SharePoint Framework. В результате это может препятствовать тестированию веб-частей.

Чтобы рабочая среда SharePoint Framework не блокировалась прокси-сервером разработки, настройте прокси-сервер разработки так, чтобы он избегал перехвата запросов к API веб-части. В файле конфигурации прокси-сервера разработки исключите API, обновив urlsToWatch свойство.

Файл: devproxyrc.json (раздел urlsToWatch с исключениями)

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

Совет

Если вы используете предустановку SPFx из коллекции примеров решений, она уже исключает этот URL-адрес из обработки Dev Proxy.

См. также

  • Last updated on