Поделиться через

Локальная отладка подключаемых модулей API

Подключаемые модули API позволяют декларативным агентам в Microsoft 365 Copilot вызывать REST API для получения данных и выполнения задач. Тем не менее, эти API-интерфейсы должны размещаться на серверах, адресуемых через Интернет, чтобы Microsoft 365 Copilot достигли их. Как правило, средства отладки размещают сеансы отладки в localhost (127.0.0.1), который доступен только с компьютера, на котором запущено средство отладки. Используя обратный прокси-сервер, например туннель разработки, вы можете предоставить сеанс отладки в Интернете, чтобы включить отладочные вызовы из Microsoft 365 Copilot.

В этой статье показано, как использовать devtunnel средство для включения локальной отладки для API.

Примечание.

Средства отладки могут уже предоставлять решение для обратного прокси-сервера. Мы рекомендуем проверить документацию по средствам разработчика для подтверждения. Например, если вы создали новый API с помощью microsoft 365 Agents Toolkit (эволюция набора средств Teams), этот набор будет обрабатывать настройку обратного прокси-сервера.

Предварительные условия

  • Интерфейс командной devtunnel строки , установленный на компьютере, где размещаются сеансы отладки
  • Номер порта HTTP, используемый средством отладки

Создание постоянного туннеля разработки

Интерфейс devtunnel командной строки позволяет создать постоянный туннель разработки — туннель, который можно остановить и запустить при необходимости без изменения размещенного URL-адреса. Использование туннеля с постоянным URL-адресом упрощает отладку подключаемых модулей API, так как нет необходимости обновлять пакеты приложений декларативного агента новыми URL-адресами.

  1. Если вы еще не вошли в интерфейс командной строки devtunnel, используйте для devtunnel user login --help просмотра доступных параметров. Войдите в CLI, прежде чем продолжить.

  2. Создайте туннель, разрешив анонимный доступ. Анонимный доступ необходим для предоставления Microsoft 365 Copilot доступа к туннелю и не связан с проверкой подлинности, требуемой API.

    devtunnel create --allow-anonymous

    Совет

    При создании нового туннеля туннель по умолчанию переключается на только что созданный. Это позволяет опустить аргумент для tunnel-id последующих команд. При создании нескольких туннелей может потребоваться использовать tunnel-id аргумент , чтобы убедиться, что используется ожидаемый туннель. Дополнительные сведения см. в devtunnel --help статье Справочник по командной строке туннелей разработки.

  3. Добавьте номер порта HTTP, используемый средством отладки. Замените <port> номером порта и задайте --protocol для параметра значение https , если средство отладки использует HTTPS на порту или http если оно не использует HTTPS.

    devtunnel port create --port-number <port> --protocol https

  4. Запустите туннель разработки.

    devtunnel host

  5. При первом запуске этого туннеля разработки скопируйте URL-адрес с меткой Connect через браузер. Откройте этот URL-адрес в браузере и нажмите кнопку Продолжить , чтобы включить туннель.

    Примечание.

    После нажатия кнопки Продолжить в браузере отобразится сообщение об ошибке. Это ожидаемо, и его можно игнорировать.

  6. Сохраните URL-адрес в качестве базового URL-адреса API.

После включения туннеля можно остановить туннель, нажав клавиши CTRL+C. Можно перезапустить туннель с помощью devtunnel host host-id команды .

Использование туннеля разработки

Чтобы использовать туннель разработки для отладки, необходимо загрузить неопубликованный пакет приложения со спецификацией OpenAPI, которая использует URL-адрес туннеля разработки в массиве servers . Дополнительные сведения см. в справочнике по OpenAPI.

servers:
  - url: <your-dev-tunnel-url>

Если вы используете Agent Toolkit в Visual Studio Code для управления декларативным агентом, вы можете добавить переменную среды в файл OPENAPI_SERVER_URL/env/.env.dev.user и обновить спецификацию OpenAPI, чтобы использовать эту переменную среды. Используйте шаг Подготовка на панели Жизненный цикл , чтобы загрузить неопубликованный агент.

В спецификации OpenAPI добавьте:

servers:
  - url: ${{OPENAPI_SERVER_URL}}

В файле /env/.env.dev.user добавьте:

OPENAPI_SERVER_URL=<your-dev-tunnel-url>

Если вы не используете Набор средств агентов, вы можете создать НОВЫЙ ZIP-файл пакета приложения и отправить агент.