Editar

Compartilhar via


Construtor de API de Dados de Host em Aplicativos Web Estáticos do Azure (versão prévia)

Diagrama do local atual ('Publicar') na sequência do guia de implantação.

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á realçado no momento.

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.

  • Banco de dados com suporte existente endereçável do Azure.

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á esse grupo de recursos para todos os novos recursos neste guia.

    Captura de tela da guia 'Noções básicas' da página 'Criar um grupo de recursos' no portal do Azure.

    Ponta

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

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

    Ambiente 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
    de origem Selecione do GitHub
    conta do GitHub Configurar uma conta do GitHub que tenha acesso ao repositório de aplicativos Web
    da Organização Selecione a organização ou o usuário pai para o repositório
    do Repositório Selecione o nome do repositório
    Branch Selecione o branch primário

    Captura de tela da guia

  4. Aguarde a conclusão da implantação do aplicativo Web estático. Um fluxo de trabalho do GitHub Actions é adicionado automaticamente ao repositório que implantará o aplicativo nos Aplicativos Web Estáticos do Azure sempre que você enviar por push para o branch primário.

    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.

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

  6. Na seção do Essentials, use a URL hiperlink 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.

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

    Ponta

    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 de codespaces do GitHub. Verifique se os CLIs de SWA e DAB estão instalados em seu ambiente de desenvolvimento.

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

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

  4. 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. Repita dab add quantas vezes quiser para suas entidades.

    dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
    
  5. Abra e examine o conteúdo do arquivo swa-db-connections/staticwebapp.database.config.json.

  6. Confirme suas alterações no repositório e envie-as por push para o branch primário. 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.

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

  2. Selecione a opção de conexão de banco de dados na seção Configurações do do menu de recursos. Em seguida, selecione Vincular de banco de dados existentes para o ambiente de de produção .

    Captura de tela da opção 'Conexão de banco de dados' na página Aplicativos Web Estáticos do Azure do portal do Azure.

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

    Ambiente 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

    Captura de tela da caixa de diálogo 'Vincular banco de dados' para conexões de banco de dados na página Aplicativos Web Estáticos do Azure do portal do Azure.

    Ponta

    É 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 ponto de extremidade da API de dados

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 de URL na seção Essentials para navegar até o site do aplicativo Web estático novamente.

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

    { Healthy }
    
  4. Navegue até o caminho https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> para o aplicativo em execução atual. 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.

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

  2. Na barra de comandos , selecione Excluir.