Início Rápido: Use App Builder com o Data API Builder da Microsoft para Qualquer Banco de Dados
Este guia fornece um processo passo a passo para configurar e usar o Data API Builder com qualquer banco de dados, lista completa dos bancos de dados suportados - SQL Server, MySQL e PostgreSQL, entre outros. Siga estas instruções para criar pontos de extremidade REST do OpenAPI nativo, Swagger e gerenciar seu banco de dados de forma eficaz.
Principais Recursos
- Suporte para tabelas relacionais, visualizações e procedimentos armazenados
- Suporte para múltiplas fontes de dados simultâneas
- Pontos de extremidade REST
- POST, GET, PUT, PATCH, DELETE
- Filtragem, classificação e paginação
- Cache em memória
- Suporte para OpenAPI
- Desenvolvimento fácil via CLI dedicada
- Código Aberto e Gratuito
Este diagrama mostra a relação entre todos os componentes da Arquitetura do Data API Builder.
Arquitetura DAB
1. Instale o pacote Microsoft.DataApiBuilder do NuGet como uma ferramenta .NET
Para começar, use dotnet tool install para instalar a versão mais recente do Microsoft.DataApiBuilder com o argumento —global:
dotnet tool install -g Microsoft.DataApiBuilder
Note
Se o pacote já estiver instalado, você atualizará o pacote em vez disso usando dotnet tool update
dotnet tool update --global Microsoft.DataApiBuilder
Para mais detalhes, consulte a documentação oficial: .
2. Configuração do Banco de Dados
Certifique-se de que você tem um banco de dados configurado. Você pode usar ferramentas como SQL Server Management Studio, MySQL Workbench ou qualquer outra ferramenta de gerenciamento de banco de dados para criar e configurar seu banco de dados. Para este guia, forneceremos exemplos para banco de dados MSSQL.
3. Pontos de Extremidade REST no Data API Builder criados através de um arquivo de configuração
O Data API Builder fornece uma API Web RESTful que permite acessar tabelas, visualizações e procedimentos armazenados de um banco de dados conectado. As entidades representam um objeto de banco de dados na configuração de tempo de execução do Data API Builder. Uma entidade deve ser definida na configuração de tempo de execução para estar disponível no ponto de extremidade da API REST.
Agora vamos criar um arquivo de configuração de linha de base usando a CLI do DAB. Documentação oficial. Este arquivo de configuração é necessário para definir como o Data API Builder interage com seu banco de dados.
Execute o seguinte comando para inicializar um arquivo de configuração baseado na cadeia de conexão MSSQL.
dab init --database-type "mssql" --host-mode "Development" --connection-string "Server=DEV-ZKOLEV4\SQLEXPRESS;User Id=INFRAGISTICS/ZKolev;Database=NorthwindCRUD;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;"
Adicione as entidades com as quais sua API REST funcionará
Adicione uma entidade (por exemplo, Produtos) ao arquivo de configuração:
dab add Products --source "Products" --permissions "anonymous:*"
Observe seu arquivo de configuração dab-config.json atual
O arquivo deve incluir uma implementação de linha de base de sua API com uma única entidade, um ponto de extremidade da API REST:
Note
Ative o CORS se necessário (Opcional). Para permitir solicitações entre origens, ative o CORS em sua configuração adicionando o seguinte ao seu custom-config.json:
"origins": ["*"]
{
"$schema": "https://github.com/Azure/data-api-builder/releases/download/v1.4.26/dab.draft.schema.json",
"data-source": {
"database-type": "mssql",
"connection-string": "Server=DEV-ZKOLEV4\\SQLEXPRESS;User Id=INFRAGISTICS/ZKolev;Database=NorthwindCRUD;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;",
"options": {
"set-session-context": false
}
},
"runtime": {
"rest": {
"enabled": true,
"path": "/api",
"request-body-strict": true
},
"graphql": { ... },
"host": {
"cors": {
"origins": [
"*"
],
"allow-credentials": false
},
"authentication": {
"provider": "StaticWebApps"
},
"mode": "development"
}
},
"entities": {
...
"Products": {
"source": {
"object": "Products",
"type": "table"
},
"graphql": {
"enabled": true,
"type": {
"singular": "Products",
"plural": "Products"
}
},
"rest": {
"enabled": true
},
"permissions": [
{
"role": "anonymous",
"actions": [
{
"action": "*"
}
]
}
]
}
}
}
4. Teste a API REST
Agora, inicie a ferramenta Data API Builder para validar que tudo está configurado corretamente.
dab start
Saída. Uma vez que a API está em execução, você pode acessá-la em http://localhost:5000/swagger/index.html
Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
Este URL abrirá a Interface do Swagger, onde você pode testar seus pontos de extremidade da API.
Exemplo de Swagger DAB
6. Comece a usar o App Builder com a API REST recém-criada
Para um passo a passo detalhado, siga este tópico.
DAB no AB
6. Solução de Problemas Comuns
Aqui estão alguns problemas comuns e suas soluções:
-
No App Builder, o CRUD funciona apenas para Grid; para o componente Form, existem algumas partes faltando da especificação OpenAPI que estão atualmente em andamento.
-
Problemas de CORS. Como ativar o CORS se necessário:
"host": {
"cors": {
"origins": [
"*"
],
"allow-credentials": false
},
"authentication": {
"provider": "StaticWebApps"
},
"mode": "development"
}
-
Proposta de Suporte do OpenID Connect - Issue no GitHub do data-api-builder.
-
Ponto de extremidade DELETE não funciona? Certifique-se de que a operação DELETE está habilitada nas permissões para a entidade (por exemplo, “anonymous:*” inclui DELETE).
-
Problemas na cadeia de conexão? Verifique novamente o nome de usuário, a senha e o método de autenticação (por exemplo, Autenticação do Windows ou Autenticação SQL) em sua cadeia de conexão.
