Построитель API данных узла в статических веб-приложениях Azure (предварительная версия)

схему текущего расположения ('Publish') в последовательности руководства по развертыванию.

Схема последовательности руководства по развертыванию, включая следующие расположения: обзор, планирование, подготовка, публикация, мониторинг и оптимизация. В настоящее время выделено расположение "Опубликовать".

Построитель API данных узла быстро используется в статических веб-приложениях Azure, используя только файл конфигурации. Это руководство содержит шаги по интеграции построителя данных с статическим веб-приложением.

В этом руководстве описано, как создать файл конфигурации DAB, разместить файл в составе приложения, а затем использовать подключение к базе данных в статических веб-приложениях Azure.

Необходимые компоненты

Важный

Поддержка построителя API данных (DAB) в статических веб-приложениях Azure с помощью подключений к базе данных доступна в предварительной версии. Статические веб-приложения Azure используют фиксированную версию ядра DAB, которая может отличаться от последней стабильной версии DAB. Чтобы получить доступ к последним функциям DAB, рассмотрите альтернативный узел для DAB, используя последнюю версию обработчика из GitHub, Реестра контейнеров Майкрософт (Docker Hub) или NuGet.

  • Интерфейс командной строки статических веб-приложений Azure. установитьстатических веб-приложений (SWA).

  • CLI построителя данных. установитепостроитель API данных (DAB).

  • Существующая поддерживаемая база данных, доступная для адреса из Azure.

Создание статического веб-приложения

Чтобы начать, используйте портал Azure для создания статического веб-приложения Azure с помощью веб-приложения в GitHub.

  1. Войдите на портал Azure (https://portal.azure.com).

  2. Создайте новую группу ресурсов. Эта группа ресурсов будет использоваться для всех новых ресурсов в этом руководстве.

    снимок экрана: вкладка

    Кончик

    Рекомендуется именовать группу ресурсов msdocs-dab-swa. Все снимки экрана в этом руководстве используют это имя.

  3. Создайте статическое веб-приложение Azure. Используйте эти параметры для настройки статического веб-приложения.

    Оправа Ценность
    группа ресурсов Выберите созданную ранее группу ресурсов
    имени Введите глобально уникальное имя
    типа плана Выберите оптимальный вариант для рабочей нагрузки
    источник Выберите GitHub
    учетной записи GitHub Настройка учетной записи GitHub с доступом к репозиторию веб-приложений
    организации Выберите родительскую организацию или пользователя для репозитория
    репозитория Выберите имя репозитория
    Филиал Выберите основную ветвь

    снимок экрана: вкладка

  4. Дождитесь завершения развертывания статического веб-приложения. Рабочий процесс GitHub Actions автоматически добавляется в репозиторий, который будет развертывать приложение в статических веб-приложениях Azure при каждом отправке в основную ветвь.

    Заметка

    Это начальное развертывание может занять несколько минут. Вы всегда можете проверить состояние развертывания на портале Azure или на вкладке "Действия GitHub" в репозитории.

  5. Перейдите к новому статическому веб-приложению на портале Azure.

  6. В разделе Essentials используйте гиперссылку URL-адрес, чтобы перейти к работающему веб-приложению. Убедитесь, что приложение работает должным образом.

Добавление файла конфигурации DAB

Теперь используйте интерфейсы командной строки DAB и SWA, чтобы создать новый файл конфигурации DAB и добавить его в репозиторий веб-приложений.

  1. Откройте репозиторий GitHub для веб-приложения в интегрированной среде разработчика (IDE) выбранного варианта.

    Кончик

    Вы можете использовать любую интегрированную среду разработки, которую вы хотите. Если вы хотите локально работать с приложением, вы можете клонировать репозиторий на локальный компьютер. Если вы предпочитаете работать в браузере, вы можете использовать GitHub Codespaces. Убедитесь, что в среде разработки установлены среды clis SWA и DAB.

  2. Откройте терминал в корневом каталоге репозитория.

  3. Используйте команду swa db из интерфейса командной строки SWA, чтобы инициализировать новый файл конфигурации DAB с помощью указанного типа базы данных. Команда создаст новый файл с именем staticwebapp.database.config.json в папке swa-db-connections.

    swa db init --database-type "<database-type>"
    

    Важный

    Для некоторых типов баз данных требуются дополнительные параметры конфигурации при инициализации.

  4. Используйте команду dab add, чтобы добавить хотя бы одну сущность базы данных в конфигурацию. Настройте каждую сущность, чтобы разрешить все разрешения для анонимных пользователей. Повторяйте dab add столько раз, сколько вам нравится для сущностей.

    dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
    
  5. Откройте и просмотрите содержимое файла swa-db-connections/staticwebapp.database.config.json.

  6. Зафиксируйте изменения в репозитории и отправьте их в основную ветвь. Это автоматически активирует новое развертывание веб-приложения. Дождитесь завершения последнего развертывания, прежде чем продолжить работу с этим руководством.

Настройка подключения к базе данных

Затем настройте подключение к базе данных на портале Azure, чтобы разрешить статическому веб-приложению доступ к базе данных.

  1. Снова перейдите к статическому веб-приложению на портале Azure.

  2. Выберите параметр подключения к базе данных в разделе параметров меню ресурсов. Затем выберите Связать существующую базу данных для рабочей среды .

    снимок экрана: параметр

  3. В диалоговом окне базы данных link используйте эти параметры для настройки подключения к базе данных.

    Оправа Ценность
    тип базы данных Выберите тот же тип базы данных, который использовался при создании файла конфигурации DAB
    группа ресурсов Выберите группу ресурсов, созданную ранее в этом руководстве
    имени ресурса Выберите ресурс базы данных, который требуется связать со статическим веб-приложением
    имя базы данных Введите имя базы данных
    типа проверки подлинности Выберите тип проверки подлинности, который вы планируете использовать

    снимок экрана диалогового окна

    Кончик

    Мы рекомендуем использовать строку подключения, которая не включает ключи авторизации. Вместо этого используйте управляемые удостоверения и управление доступом на основе ролей для управления доступом между базой данных и узлом. Дополнительные сведения см. в службах Azure, использующих управляемые удостоверения.

Проверка конечной точки API данных

Наконец, убедитесь, что конечная точка API данных доступна в статическом веб-приложении.

  1. Снова перейдите к статическому веб-приложению на портале Azure.

  2. Используйте поле URL-адрес в разделе Essentials, чтобы снова перейти на веб-сайт статического веб-приложения.

  3. Перейдите к /data-api пути для текущего работающего приложения. Обратите внимание, что ответ по-прежнему указывает, что контейнер DAB работоспособным.

    { Healthy }
    
  4. Перейдите к https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> пути для текущего работающего приложения. Это выдает запрос HTTP GET для этого набора сущностей. Обратите внимание на ответ JSON.

Очистка ресурсов

Если вам больше не нужен пример приложения или ресурсов, удалите соответствующее развертывание и все ресурсы.

  1. Перейдите к группе ресурсов с помощью портала Azure.

  2. В строке команд выберите Удалить.