Colaborando com a ferramenta de desenvolvimento de interfaces de programação de aplicativos do Azure para dados.

Incorpore APIs REST e GraphQL em qualquer base de dados utilizando uma prática ferramenta .NET CLI.

A estratégia da Microsoft para o desenvolvimento de nuvem, centrada em plataforma, possibilitou a disponibilização de versões controladas de diversos componentes conhecidos da área de tecnologia, especialmente em relação à sua plataforma de dados. Além de oferecer o SQL Server (como Azure SQL) e o banco de dados Cosmos DB, a empresa também disponibiliza versões gerenciadas de bancos de dados de código aberto populares, como PostgreSQL e MySQL.

Utilizar esses bancos de dados e APIs conhecidos simplifica a transferência de dados para o Azure ou o desenvolvimento de novos aplicativos nativos na nuvem sem uma grande curva de aprendizado. Uma vez que os dados estejam armazenados no Azure, é possível utilizar ferramentas e técnicas familiares para trabalhar com eles em seu código, especialmente se estiver utilizando .NET e Java, que possuem diversos SDKs oficiais e não oficiais. No entanto, se estiver adotando abordagens mais recentes de desenvolvimento, como o Jamstack e utilizando ferramentas como o Azure Static Web Apps, para incluir APIs front-end em suas aplicações, como proceder?

Embora seja possível criar sua própria camada de API de dados com ferramentas como o Azure Functions ou o App Service, isso pode gerar ineficiências e aumentar os requisitos de manutenção e teste. Uma alternativa é utilizar a ferramenta de construtor de API de dados da Microsoft, que é fácil de configurar e fornece um banco de dados de endpoints REST ou GraphQL que pode ser facilmente consumido por JavaScript ou qualquer outra linguagem que suporte REST. Esta abordagem também pode ser a forma mais rápida de começar a transformar bancos de dados hospedados no Azure em aplicativos.

Apresentação do Criador de Interface de Programação de Aplicativos de Dados

O Data API builder é uma ferramenta de código aberto que foi desenvolvida para funcionar em diferentes ambientes, como localmente, na borda e na nuvem, e tem como objetivo suportar cinco tipos de banco de dados: Azure SQL, SQL Server, PostgreSQL, MySQL e Cosmos DB. Ele permite que você trabalhe tanto com suas próprias instalações quanto com os serviços gerenciados da Microsoft, possibilitando o desenvolvimento e execução no seu data center e a migração para a nuvem conforme necessário.

Se você estiver integrando o Data API builder em seu próprio código, é uma ferramenta .NET disponível como um pacote Nuget. É necessário ter o .NET 6 ou 7 para usá-lo e pode ser executado em qualquer sistema compatível com o .NET, incluindo o Linux. Após a instalação, é possível utilizar o CLI para criar os endpoints necessários para os bancos de dados, prontos para serem usados em suas aplicações. Outra opção é utilizar uma imagem de contêiner pronta para ser executada no registro de contêineres da Microsoft. Essa abordagem é ideal para ambientes de contêineres de borda, como o Azure Kubernetes Service (AKS) Edge Essentials, que oferece uma plataforma gerenciada limitada baseada em Kubernetes.

A configuração é ágil e é possível utilizar a ferramenta com o comando dab em qualquer linha de comando. Apesar de o suporte ser simples, devido à especialização da ferramenta, não deve ser complicado utilizá-la. Ferramentas de linha de comando específicas, como esta, estão se tornando cada vez mais relevantes no ecossistema .NET, sendo útil se familiarizar com elas, já que podem otimizar o trabalho e poupar tempo.

Criar interfaces de programação de aplicativos usando a linha de comando.

É recomendável ter conhecimento sobre a ADO.NET ao utilizar o Data API builder. Isso é algo esperado, já que é a forma convencional de acessar serviços de dados no ambiente .NET. Mesmo ao desenvolver aplicações web com essa ferramenta, é fundamental ter em mente que ela é essencialmente uma ferramenta do .NET.

Para estabelecer uma conexão, é necessário ter conhecimento da estrutura do banco de dados e dos elementos a serem acessados. Além disso, é preciso ter a string de conexão ADO para realizar a conexão inicial. No caso de recursos do Azure, essas informações podem ser encontradas no Azure Portal, como parte das propriedades dos recursos. Não é necessário armazenar esses dados de conexão de forma explícita; é possível utilizar variáveis de ambiente para manter essas informações fora do código durante a execução, garantindo a segurança dos dados com ferramentas como o Azure Key Vault.

O compilador de API de dados usa um arquivo de configuração JSON para armazenar informações sobre qualquer API criada. Esse arquivo define o tipo de banco de dados e a cadeia de conexão, além de exigir uma conta com permissões adequadas. É possível ativar o REST, GraphQL ou ambos, especificar se o scripting de origem cruzada é permitido e definir o tipo de autenticação usado para a conexão. A ferramenta CLI é responsável por criar e atualizar o arquivo de configuração, mas também é possível editá-lo seguindo a documentação disponível no GitHub.

Após estabelecer uma conexão, é possível ajustar as configurações das APIs para seus dados. Ao utilizar entidades de banco de dados conhecidas, é necessário nomear a API e vinculá-la a uma fonte, como uma tabela ou consulta, definindo permissões específicas para usuários e operações de banco de dados. O nome desempenha um papel na construção do caminho da API para REST e GraphQL.

Com uma configuração de conexão estabelecida e entidades incluídas no arquivo de configuração, você está pronto para construir e disponibilizar a API. O Construtor de API de dados pode ser visto como um intermediário simples que recebe conexões REST e GraphQL, as mapeia para instruções ADO pré-definidas, as executa na fonte para obter resultados e as remapeia para o formato adequado. A API REST oferece suporte a verbos comuns que correspondem às operações padrão CRUD (criar, ler, atualizar, excluir); por exemplo, o GET recupera dados e o POST os insere.

Cada verbo REST possui parâmetros de consulta extras que auxiliam no gerenciamento dos dados, permitindo filtrar, ordenar e aplicar declarações selecionadas. Atualmente, não há uma opção para paginar os dados, mas espera-se que isso seja incluído em futuras versões para facilitar a construção de conteúdo web com base nos dados consultados.

Utilizando o Gráfico QL em conjunto com um compilador de API de dados.

Se está pensando em utilizar o GraphQL, é recomendável utilizar uma ferramenta como o Postman para facilitar a criação e teste de requisições. Enquanto o GraphQL pode ir além de uma simples consulta REST, pode ser desafiador construir consultas manualmente. Contar com uma ferramenta para explorar a API e testar as consultas pode poupar bastante tempo. Para consultas GraphQL mais complexas, será necessário configurar os relacionamentos. Nesse caso, é útil ter um diagrama de entidade da fonte de dados com os relacionamentos definidos, descrevendo o tipo de relação, a entidade-alvo da consulta e como a relação é armazenada no banco de dados.

O procedimento para criar uma API é semelhante para todos os bancos de dados compatíveis, exceto pelo Cosmos DB. Uma vez que esse banco de dados já possui uma API REST, não é necessário criar outra. No entanto, ainda é possível utilizá-lo para desenvolver uma API GraphQL.

Se estiver trabalhando com o Azure Static Web Apps, comece adicionando seu banco de dados de origem à configuração do site no Azure Portal. Em seguida, importe um arquivo de configuração do construtor de API de dados. Você tem a opção de utilizar tanto o construtor de API de banco de dados quanto o Azure Static Web Apps CLI para gerar os arquivos necessários. O CLI do Static Web Apps cria um arquivo modelo de configuração que pode ser editado manualmente ou inserido no conteúdo de um arquivo de construtor de API de banco de dados.

É crucial ter a capacidade de integrar o suporte GraphQL a qualquer banco de dados, já que essa abordagem é mais eficiente do que as APIs tradicionais, simplificando consultas complexas. Ao oferecer suporte a APIs REST e GraphQL, a ferramenta de construção de API de dados facilita a transição entre diferentes tipos de API, permitindo que os usuários continuem a utilizar consultas familiares enquanto aprendem a estrutura do GraphQL. Além disso, essa ferramenta é compatível com qualquer framework de aplicativo e é altamente recomendada para uso com o Azure Static Web Apps na criação de aplicativos Jamstack conectados a dados.