Início Rápido: Usar o construtor de API de Dados com o PostgreSQL

Neste 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 PostgreSQL local.

Pré-requisitos

• Docker
• .NET 8

Instalar a CLI do construtor de API de Dados

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

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

   dotnet tool install --global Microsoft.DataApiBuilder
   

   Observação

   Se o pacote já estiver instalado, atualize o pacote usando dotnet tool update.

   dotnet tool update --global Microsoft.DataApiBuilder
   

2. Verifique se a ferramenta está instalada usando dotnet tool list o --global argumento.

   dotnet tool list --global
   

Configurar o banco de dados local

Comece configurando e executando o banco de dados local. Em seguida, você pode semear um novo contêiner usando dados de amostra.

1. Obtenha a versão mais recente da imagem de contêiner postgres:16 do Docker Hub.

   docker pull postgres:16
   

2. Inicie o contêiner do Docker definindo a senha e a porta de publicação 5432. Substitua <your-password> por uma senha personalizada.

   docker run \
       --publish 5432:5432 \
       --env "POSTGRES_PASSWORD=<your-password>" \
       --detach \
       postgres:16
   

3. Conecte-se ao banco de dados local usando seu ambiente de gerenciamento de dados preferido. Exemplos incluem, mas não se limitam a: pgAdmin e a extensão PostgreSQL para Visual Studio Code.

   Dica

   Se você estiver usando a rede padrão para suas imagens de contêiner do Docker Linux, a cadeia de conexão provavelmente será Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;. Substitua <your-password> pela senha definida anteriormente.

4. Criar um novo banco de dados bookshelf.

   DROP DATABASE IF EXISTS bookshelf;
   
   CREATE DATABASE bookshelf;
   

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

   CREATE TABLE IF NOT EXISTS authors
   (
       id INT NOT NULL PRIMARY KEY,
       first_name VARCHAR(100) NOT NULL,
       middle_name VARCHAR(100),
       last_name VARCHAR(100) NOT NULL
   );
   
   INSERT INTO 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');
   

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.

1. Criar um arquivo de configuração típico usando dab init. Adicione o argumento --connection-string com sua cadeia de conexão de 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 "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
   

2. Adicionar uma entidade Author usando dab add.

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

Testar a API com o banco de dados local

Agora, inicie a ferramenta construtor de API de Dados para validar se os arquivos de configuração são mesclados durante o desenvolvimento.

1. Use dab start para utilizar a ferramenta e criar endpoints de API para sua entidade.

   dab start
   

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

   Dica

   Neste exemplo, o aplicativo está sendo executado em localhost na porta 5000. Seu aplicativo em execução pode ter um endereço e uma porta diferentes.

3. Primeiro, experimente a API manualmente emitindo uma solicitação GET para /api/Author.

   Dica

   Neste exemplo, a URL seria https://localhost:5000/api/Author. Você pode navegar até essa URL usando seu navegador da Web.

4. Em seguida, navegue até a página de documentação do Swagger em /swagger.

   Dica

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

Próxima etapa