Construtor de API de Dados de Host em Aplicativos Web Estáticos do Azure (versão prévia)
Diagrama da sequência do guia de implantação, incluindo esses locais, em ordem: Visão geral, Plano, Preparação, Publicação, Monitor e Otimização. O local 'Publicar' está atualmente realçado.
Hospede o construtor de API de Dados rapidamente nos Aplicativos Web Estáticos do Azure usando apenas um arquivo de configuração. Este guia inclui etapas para integrar o Construtor de API de Dados a um aplicativo Web estático.
Neste guia, percorra as etapas para criar um arquivo de configuração do DAB, hospedar o arquivo como parte do aplicativo e, em seguida, usar uma conexão de banco de dados nos Aplicativos Web Estáticos do Azure.
Pré-requisitos
Importante
O suporte para o DAB (Construtor de API de Dados) nos Aplicativos Web Estáticos do Azure usando conexões de banco de dados está em versão prévia. Os Aplicativos Web Estáticos do Azure usam uma versão fixa do mecanismo DAB que pode variar da versão estável mais recente do DAB. Para acessar os recursos mais recentes do DAB, considere um host alternativo para DAB usando a versão mais recente do mecanismo do GitHub, do Registro de Contêiner da Microsoft (Hub do Docker) ou do NuGet.
- Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
- CLI de Aplicativos Web Estáticos do Azure. Instalar a CLI dos Aplicativos Web Estáticos (SWA).
- CLI do construtor de API de Dados. Instalar a CLI do DAB (Construtor de API de Dados).
- Banco de dados existente com suporte acessível a partir do Azure.
- Aplicativo Web existente em um repositório GitHub que pode ser implantado nos Aplicativos Web Estáticos do Azure.
- Se você não tiver um aplicativo web, gere um repositório com um aplicativo web básico.
Criar um aplicativo Web estático
Para começar, use o portal do Azure para criar um novo Aplicativo Web Estático do Azure usando o aplicativo Web no GitHub.
Entre no portal do Azure (https://portal.azure.com).
Crie um novo grupo de recursos. Você usará esse grupo de recursos para todos os novos recursos neste guia.
Dica
Recomendamos nomear o grupo de recursos msdocs-dab-swa. Todas as capturas de tela neste guia usam esse nome.
Criar um aplicativo Web estático do Azure. Use essas configurações para configurar o aplicativo Web estático.
Configuração Valor grupo de recursos Selecione o grupo de recursos que você criou anteriormente Name Inserir um nome global exclusivo Tipo de plano Selecione a melhor opção para sua carga de trabalho Fonte Selecione GitHub conta do GitHub Configurar uma conta do GitHub que tenha acesso ao repositório de aplicativos Web Organização Selecione a organização ou o usuário pai para o repositório Repositório Selecione o nome do repositório Branch Selecione o ramo principal Aguarde a conclusão da implantação do aplicativo Web estático. Um fluxo de trabalho do GitHub Actions é automaticamente adicionado ao seu repositório e implantará o aplicativo nos Aplicativos Web Estáticos do Azure toda vez que você enviar por push para o branch principal.
Nota
Essa implantação inicial pode levar alguns minutos. Você sempre pode verificar o status da implantação no portal do Azure ou na guia Ações do GitHub em seu repositório.
Navegue até o novo aplicativo Web estático no portal do Azure.
Na seção Essentials, use o hiperlink URL para navegar até o aplicativo Web em execução. Verifique se o aplicativo está em execução conforme o esperado.
Adicionar o arquivo de configuração do DAB
Agora, use as interfaces de linha de comando DAB e SWA para criar um novo arquivo de configuração do DAB e adicioná-lo ao repositório de aplicativos Web.
Abra o repositório GitHub para seu aplicativo Web no IDE (ambiente de desenvolvedor integrado) de sua escolha.
Dica
Você pode usar qualquer IDE que desejar. Se você quiser trabalhar no aplicativo localmente, poderá clonar o repositório no computador local. Se você preferir trabalhar no navegador, poderá usar GitHub Codespaces. Verifique se os CLIs de SWA e DAB estão instalados em seu ambiente de desenvolvimento.
Abra um terminal na raiz do repositório.
Use o comando
swa db
da CLI da SWA para inicializar um novo arquivo de configuração do DAB usando o tipo de banco de dados especificado. O comando criará um novo arquivo chamado staticwebapp.database.config.json na pasta swa-db-connections.swa db init --database-type "<database-type>"
Importante
Alguns tipos de banco de dados exigirão configurações adicionais na inicialização.
Use o comando
dab add
para adicionar pelo menos uma entidade de banco de dados à configuração. Configure cada entidade para permitir todas as permissões para usuários anônimos. Repitadab add
quantas vezes você quiser para suas entidades.dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
Abra e examine o conteúdo do arquivo swa-db-connections/staticwebapp.database.config.json.
Confirme suas alterações no repositório e envie-as para o branch principal. Isso disparará automaticamente uma nova implantação do aplicativo Web. Aguarde até que esta implantação mais recente seja concluída antes de continuar com este guia.
Configurar a conexão de banco de dados
Em seguida, configure a conexão de banco de dados no portal do Azure para permitir que o aplicativo Web estático acesse o banco de dados.
Navegue até o aplicativo Web estático novamente no portal do Azure.
Selecione a opção conexão de banco de dados na seção Configurações do menu de recursos. Em seguida, selecione Vincular banco de dados existente para o ambiente de produção.
Na caixa de diálogo do banco de dados Link, use essas configurações para configurar a conexão de banco de dados.
Configuração Valor tipo de banco de dados Selecione o mesmo tipo de banco de dados usado ao criar o arquivo de configuração do DAB grupo de recursos Selecione o grupo de recursos que você criou anteriormente neste guia nome do recurso Selecione o recurso de banco de dados que você deseja vincular ao aplicativo Web estático nome do banco de dados Insira o nome do banco de dados tipo de autenticação Selecione o tipo de autenticação que você pretende usar Dica
É recomendável usar uma cadeia de conexão que não inclua chaves de autorização. Em vez disso, use identidades gerenciadas e controle de acesso baseado em função para gerenciar o acesso entre o banco de dados e o host. Para obter mais informações, consulte serviços do Azure que usam identidades gerenciadas.
Testar o endpoint da API de dados
Por fim, valide se o ponto de extremidade da API de dados está disponível no aplicativo Web estático.
Navegue até o aplicativo Web estático novamente no portal do Azure.
Use o campo de URL na seção Essentials para navegar até o site do aplicativo Web estático novamente.
Navegue até o caminho
/data-api
para o aplicativo atualmente em execução. Observe que a resposta ainda indica que o contêiner da DAB está íntegro.{ Healthy }
Nota
Os Aplicativos Web Estáticos automaticamente configuram o modo de host do runtime como
Production
, substituindo qualquer valor no arquivo de configuração. Como resultado, recursos de desenvolvedor como Swagger e Banana Cake Pop não estão disponíveis em Aplicativos Web Estáticos.Navegue até o caminho
https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name>
para o aplicativo atualmente em execução. Isso emite uma solicitação HTTP GET para esse conjunto de entidades. Observe a resposta JSON.
Limpar recursos
Quando você não precisar mais do aplicativo de exemplo ou dos recursos, remova a implantação correspondente e todos os recursos.
Navegue até o grupo de recursos usando o portal do Azure.
Na barra de comandos , selecione Excluir.