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

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

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

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

Предпосылки

Это важно

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

• Учетная запись Azure с активной подпиской. Создайте учетную запись бесплатно .
• Интерфейс командной строки статических веб-приложений Azure. Установите интерфейс командной строки статических веб-приложений (SWA).
• CLI инструмента построения API данных. Установите конструктор Data API (DAB) CLI.
• Существующая поддерживаемая база данных, доступная для адреса из Azure.
• Существующее веб-приложение в репозитории GitHub, которое можно развернуть в статических веб-приложениях 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. В диалоговом окне "Ссылка" используйте эти параметры для настройки подключения к базе данных.

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

   

   Подсказка

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

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

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

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

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

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

   { Healthy }
   

   Замечание

   Статические веб-приложения автоматически задают режим Productionузла среды выполнения, перезаписав любое значение в файле конфигурации. В результате функции разработчика, такие как Swagger и Banana Cake Pop, недоступны в статических веб-приложениях.

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

Очистите ресурсы

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

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

2. На панели команд нажмите кнопку "Удалить".