Guia de início rápido: usar o construtor de API de dados com SQL

Neste Guia de início rápido, você cria um conjunto de arquivos de configuração do construtor de API de dados para direcionar um banco de dados SQL local.

Pré-requisitos

Docker
.NET 8
Um cliente de gerenciamento de dados
- Se não tiver um cliente instalado, instale o SQL Server Management Studio.

Sugestão

Como alternativa, abra este Guia de início rápido no GitHub Codespaces com todos os pré-requisitos do desenvolvedor já instalados. Traga a sua própria subscrição do Azure. As contas do GitHub incluem um direito de armazenamento e horas essenciais sem nenhum custo. Para obter mais informações, consulte armazenamento incluído e horas principais para contas do GitHub.

Instalar a CLI do construtor de API de dados

Instale o Microsoft.DataApiBuilder pacote do NuGet como uma ferramenta .NET.

Use dotnet tool install para instalar a versão mais recente do Microsoft.DataApiBuilder com o --global argumento.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Observação

Se o pacote já estiver instalado, atualize-o usando dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Verifique se a ferramenta está instalada com dotnet tool list utilizando o argumento --global.
```
dotnet tool list --global
```

Configurar o banco de dados local

Comece configurando e executando o banco de dados local para definir as credenciais relevantes. Em seguida, você pode semear o banco de dados com dados de exemplo.

Obtenha a cópia mais recente da imagem do mcr.microsoft.com/mssql/server:2022-latest contêiner do Docker Hub.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Inicie o contêiner do docker definindo a senha, aceitando o contrato de licença de usuário final (EULA) e publicando a porta 1433. Substitua <your-password> por uma senha personalizada.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Conecte-se ao seu banco de dados local usando seu ambiente de gerenciamento de dados preferido. Exemplos incluem, mas não se limitam a: SQL Server Management Studio e a extensão SQL Server para Visual Studio Code.

Sugestão

Se estiver a usar a rede por defeito para as imagens dos seus contentores Docker Linux, a cadeia de conexão provavelmente será Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Substitua <your-password> pela senha definida anteriormente.

Crie um novo bookshelf banco de dados e use o banco de dados para suas consultas restantes.

DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO

Crie uma nova dbo.authors tabela e semeie a tabela com dados básicos.

DROP TABLE IF EXISTS dbo.authors;
GO

CREATE TABLE dbo.authors
(
    id int not null primary key,
    first_name nvarchar(100) not null,
    middle_name nvarchar(100) null,
    last_name nvarchar(100) not null
)
GO

INSERT INTO dbo.authors VALUES
    (01, 'Henry', null, 'Ross'),
    (02, 'Jacob', 'A.', 'Hancock'),
    (03, 'Sydney', null, 'Mattos'),
    (04, 'Jordan', null, 'Mitchell'),
    (05, 'Victoria', null, 'Burke'),
    (06, 'Vance', null, 'DeLeon'),
    (07, 'Reed', null, 'Flores'),
    (08, 'Felix', null, 'Henderson'),
    (09, 'Avery', null, 'Howard'),
    (10, 'Violet', null, 'Martinez')
GO

Criar arquivos de configuração

Crie um arquivo de configuração de linha de base usando a CLI do DAB. Em seguida, adicione um arquivo de configuração de desenvolvimento com suas credenciais atuais.

Crie um arquivo de configuração típico usando dab init. Adicione o argumento --connection-string com a cadeia de conexão do banco de dados da primeira seção. Substitua <your-password> pela senha definida anteriormente neste guia. Além disso, adicione o valor Database=bookshelf à cadeia de conexão.
```
dab init --database-type "mssql" --host-mode "Development" --connection-string "Server=localhost,1433;User Id=sa;Database=bookshelf;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;"
```

Adicione uma entidade Autor usando dab add.

dab add Author --source "dbo.authors" --permissions "anonymous:*"

API de teste com o banco de dados local

Agora, inicie a ferramenta Data API builder para validar que seus arquivos de configuração são mesclados durante o desenvolvimento.

Use dab start para executar a ferramenta e criar endpoints de API para a sua entidade.
```
dab start
```
A saída da ferramenta deve incluir o endereço a ser usado para navegar até a API em execução.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Sugestão

Neste exemplo, o aplicativo está sendo executado na localhost porta 5000. Seu aplicativo em execução pode ter um endereço e uma porta diferentes.
Primeiro, tente a API manualmente emitindo uma solicitação GET para /api/Author.

Sugestão

Neste exemplo, a URL seria https://localhost:5000/api/Author. Você pode navegar até esse URL usando seu navegador da Web.
Em seguida, navegue até a página de documentação do Swagger em /swagger.

Sugestão

Neste exemplo, a URL seria https://localhost:5000/swagger. Novamente, você pode navegar até esse URL usando seu navegador da Web.

Próximo passo

Guia de início rápido: implantar o construtor de API de dados no Azure

Feedback

Esta página foi útil?

Last updated on 2025-12-19