Разработка API данных с помощью Статические веб-приложения Azure

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

• Можно быстро разрабатывать с помощью таких платформ, как Bootstrap, Jekyll и AngularJS.
• Просто масштабироваться, так как на сервере изменения состояния не изменяются.
• Поощряйте разделение между кодом пользовательского интерфейса и функциональными возможностями внутреннего интерфейса.

Статические веб-приложения Azure — это служба в Azure, предназначенная для упрощения кода и развертывания статических веб-приложений в Azure для рабочей среды. Статические веб-приложения Azure поддерживает непрерывное развертывание путем мониторинга репозитория кода в GitHub или Azure DevOps. При внесении изменений в код веб-сайта и отправке изменений в репозиторий Статические веб-приложения Azure замещать изменения и автоматически создавать и развертывать новый сайт в Azure. Сразу же изменение становится доступным для пользователей.

Так как построитель API данных (DAB) предназначен для эффективной работы с Статические веб-приложения Azure, просто разместить API базы данных в этой службе. Все, что необходимо сделать, — использовать файл конфигурации, чтобы сообщить DAB о вашем экземпляре Статические веб-приложения Azure и развернуть его в репозитории. Статические веб-приложения Azure будет размещать API и пользователи могут начать вызывать методы.

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

Начните, перейдя на портал Azure и выбрав "Создать ресурс". В строке поиска введите статическое веб-приложение. Когда появится карточка статического веб-приложения , выберите ее и нажмите кнопку "Создать".

Затем выберите свою подписку и выберите существующую группу ресурсов или создайте новую. В текстовом поле "Имя" введите описательное имя приложения. Необходимо выбрать тип плана. Для личных проектов можно использовать бесплатный план, а для рабочих приложений рекомендуется использовать стандартный план.

В разделе "Сведения о развертывании" укажите тип репозитория, содержащего приложение. Необходимо войти в GitHub или выбрать репозиторий и ветвь в Azure DevOps. Наконец, просмотрите параметры, выбрав "Просмотр и создание", а затем нажмите кнопку "Создать ", чтобы завершить процесс.

Создание файла конфигурации построителя данных

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

• swa: инициализировать новый файл конфигурации DAB с помощью этого интерфейса командной строки.
• dab: используйте этот интерфейс командной строки для добавления одной или нескольких баз данных в файл.

Прежде чем начать, клонируйте репозиторий GitHub на локальный компьютер или используйте GitHub Codespaces для открытия командной строки в самом GitHub.

1. Чтобы инициализировать файл конфигурации DAB в корневой папке репозитория, выполните следующую команду.

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

   Замените <database type> сервером базы данных. Например, если база данных размещена в База данных SQL Azure, используйте mssql. Если он находится в MySQL, используйте mysql.

2. Чтобы добавить базу данных в файл конфигурации, выполните следующую команду.

   dab add "<database-name>" --source "<schema>.<table>" --permissions "anonymous:*" -config "swa-db-connections/staticwebapp.database.config.json"
   

   Замените <database-name> описательным именем и <schema>.<table> именем схемы и таблицы в базе данных.

Эти действия создают файл конфигурации в репозитории с именем swa-db-connections/staticwebapp.database.config.json. Просмотрите этот файл перед фиксацией изменений в репозитории.

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

Чтобы настроить подключение к базе данных в статическом веб-приложении, начните с открытия статического веб-приложения на портале Azure. Перейдите к разделу "Параметры " и выберите "Подключение к базе данных". В разделе "Рабочая среда" выберите ссылку на существующую базу данных. Выберите соответствующий тип базы данных, группу ресурсов и имя базы данных. Наконец, выберите предпочитаемый тип проверки подлинности и свяжите базу данных.

Проверка доступа к API

Чтобы проверить доступ к API, начните с открытия статического веб-приложения, созданного на портале Azure. Перейдите к разделу Essentials и выберите URL-адрес для просмотра веб-сайта. В адресной строке браузера добавьте /data-api к URL-адресу и нажмите ВВОД.

Вы увидите страницу, указывающую, что контейнер DAB работоспособен. Чтобы просмотреть сущности из базы данных, добавьте /data-api/rest/ его к URL-адресу. При этом отправляется HTTP-запрос GET и отображается ответ JSON.