Criador de Host Data API nos Azure Static Web Apps (pré-visualização)

Diagrama da sequência do guia de implantação, incluindo esses locais, na ordem: Visão geral, Planejar, Preparar, Publicar, Monitorar e Otimizar. A opção 'Publicar' está atualmente destacada.

Construa APIs de dados do host rapidamente em Aplicações Web Estáticas do Azure, usando apenas um ficheiro de configuração. Este guia inclui etapas para integrar o Data API builder com um aplicativo Web estático.

Neste guia, percorra as etapas para criar um arquivo de configuração DAB, hospedar o arquivo como parte do seu aplicativo e usar uma conexão de banco de dados nos Aplicativos Web Estáticos do Azure.

Pré-requisitos

Importante

O suporte para o construtor de API de Dados (DAB) nos Aplicativos Web Estáticos do Azure usando conexões de banco de dados está em visualização. 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 de DAB mais recentes, considere um host alternativo para DAB usando a versão mais recente do mecanismo do GitHub, Microsoft Container Registry (Docker Hub) ou NuGet.

• Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
• CLI de Aplicativos Web Estáticos do Azure. Instale a CLI de aplicativos Web estáticos (SWA).
• CLI do construtor de API de dados. Instale a CLI do construtor de API de dados (DAB).
• Base de dados existente endereçável pelo Azure.
• Aplicativo Web existente em um repositório GitHub que pode ser implantado em 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.

1. Entre no portal do Azure (https://portal.azure.com).

2. Crie um novo grupo de recursos. Você usará este grupo de recursos para todos os novos recursos neste guia.

   

   Sugestão

   Recomendamos nomear o grupo de recursos msdocs-dab-swa. Todas as capturas de tela neste guia usam esse nome.

3. Crie um Aplicativo Web Estático do Azure. Use essas configurações para configurar o aplicativo Web estático.

   Configurações	Valor
   Grupo de recursos	Selecione o grupo de recursos criado anteriormente
   Nome	Insira um nome globalmente exclusivo
   Tipo de plano	Selecione a melhor opção para a 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 pai ou o usuário para o repositório
   Repositório	Selecione o nome do repositório
   Filial	Selecione a ramificação principal

   

4. Aguarde a conclusão da implantação do aplicativo Web estático. Um fluxo de trabalho do GitHub Actions é adicionado automaticamente ao seu repositório e implantará a aplicação nos Aplicativos Web Estáticos do Azure sempre que fizer push para o ramo principal.

   Observação

   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.

5. Navegue até o novo aplicativo Web estático no portal do Azure.

6. Na secção Essenciais, use a hiperligação URL para aceder à aplicação web em execução. Verifique se o aplicativo está sendo executado conforme o esperado.

Adicionar o arquivo de configuração DAB

Agora, use as interfaces de linha de comando DAB e SWA para criar um novo arquivo de configuração DAB e adicioná-lo ao repositório de aplicativos Web.

1. Abra o repositório GitHub para seu aplicativo Web no ambiente de desenvolvedor integrado (IDE) de sua escolha.

   Sugestão

   Você pode usar qualquer IDE que desejar. Se quiser trabalhar no aplicativo localmente, você pode clonar o repositório para sua máquina local. Se preferir trabalhar no navegador, você pode usar o GitHub Codespaces. Certifique-se de que as CLIs SWA e DAB estejam instaladas em seu ambiente de desenvolvimento.

2. Abra um terminal na raiz do repositório.

3. Use o swa db comando da CLI SWA para inicializar um novo arquivo de configuração 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 definições de configuração adicionais na inicialização.

4. Use o dab add comando 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. Repita dab add tantas vezes quanto desejar para as suas entidades.

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

5. Abra e revise o conteúdo do arquivo swa-db-connections/staticwebapp.database.config.json.

6. Confirme suas alterações no repositório e envie-as para a ramificação principal. Isso acionará automaticamente uma nova implantação do aplicativo Web. Aguarde que esta última implementação termine antes de continuar com este guia.

Configurar a ligação à base 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.

1. Navegue até o aplicativo Web estático novamente no portal do Azure.

2. 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 .

   

3. Na caixa de diálogo Vincular banco de dados , use essas configurações para configurar a conexão do banco de dados.

   Configurações	Valor
   Tipo de banco de dados	Selecione o mesmo tipo de banco de dados usado ao criar o arquivo de configuração DAB
   Grupo de recursos	Selecione o grupo de recursos criado anteriormente neste guia
   Nome do recurso	Selecione o recurso de banco de dados que você deseja vincular ao aplicativo Web estático
   Nome da base de dados	Insira o nome do banco de dados
   Tipo de autenticação	Selecione o tipo de autenticação que pretende utilizar

   

   Sugestão

   Recomendamos o uso de 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 de dados da API

Por fim, valide se o ponto de extremidade da API de dados está disponível no aplicativo Web estático.

1. Navegue até o aplicativo Web estático novamente no portal do Azure.

2. Use o campo URL na seção Essentials para navegar até o site do aplicativo Web estático novamente.

3. Navegue até o caminho /data-api da aplicação atualmente em execução. Observe que a resposta ainda indica que o contêiner DAB está íntegro.

   { Healthy }
   

   Observação

   Os Aplicativos Web estáticos definem automaticamente o modo de host de tempo de execução 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.

4. Navegue até o caminho https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> da aplicação atualmente em execução. Isso emite uma solicitação HTTP GET para esse conjunto de entidades. Observe a resposta em formato JSON.

Limpeza de recursos

Quando já não precisar da aplicação ou dos recursos de amostra, remova a implementação correspondente e todos os recursos.

1. Navegue até o grupo de recursos usando o portal do Azure.

2. Na barra de comandos, selecione Excluir.