Quickstart: Data API Builder gebruiken met PostgreSQL

In deze quickstart bouwt u een set configuratiebestanden voor Data API Builder om een lokale PostgreSQL-database te targeten.

Vereiste voorwaarden

Aanbeveling

U kunt deze quickstart ook openen in GitHub Codespaces, waarbij alle vereisten voor ontwikkelaars al zijn geïnstalleerd. Gebruik gewoon uw eigen Azure-abonnement. GitHub-accounts bevatten gratis rechten voor opslag en kernuren. Zie inbegrepen opslag- en kernuren voor GitHub-accounts voor meer informatie.

De DATA API Builder CLI installeren

Installeer het Microsoft.DataApiBuilder pakket vanuit NuGet als een .NET-hulpprogramma.

Gebruik dotnet tool install om de nieuwste versie van de Microsoft.DataApiBuilder met het argument --global te installeren.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Opmerking

Als het pakket al is geïnstalleerd, werkt u het pakket bij met behulp van dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Controleer of het hulpprogramma is geïnstalleerd met dotnet tool list behulp van het --global argument.
```
dotnet tool list --global
```

De lokale database configureren

Begin met het configureren en uitvoeren van de lokale database. Vervolgens kunt u een nieuwe container met voorbeeldgegevens seeden.

Verkrijg de meest recente kopie van de postgres:16 containerafbeelding uit Docker Hub.
```
docker pull postgres:16
```
Start de Docker-container door het wachtwoord in te stellen en poort 5432 te publiceren. Vervang <your-password> door een aangepast wachtwoord.
```
docker run \
    --publish 5432:5432 \
    --env "POSTGRES_PASSWORD=<your-password>" \
    --detach \
    postgres:16
```
Maak verbinding met uw lokale database met behulp van uw voorkeursomgeving voor gegevensbeheer. Voorbeelden zijn onder andere: pgAdmin en de PostgreSQL-extensie voor Visual Studio Code.

Aanbeveling

Als u gebruikmaakt van standaard netwerken voor uw Docker Linux-container afbeeldingen, zal de verbindingsreeks waarschijnlijk Host=localhost;Port=5432;User ID=postgres;Password=<your-password>; zijn. Vervang <your-password> door het wachtwoord dat u eerder hebt ingesteld.

Maak een nieuwe bookshelf database.

DROP DATABASE IF EXISTS bookshelf;

CREATE DATABASE bookshelf;

Maak een nieuwe dbo.authors tabel en vul de tabel met basisgegevens.

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');

Configuratiebestanden maken

Maak een basislijnconfiguratiebestand met behulp van de DAB CLI. Voeg vervolgens een configuratiebestand voor ontwikkeling toe met uw huidige referenties.

Maak een typisch configuratiebestand met behulp van dab init. Voeg het --connection-string argument toe met uw databaseverbindingsreeks uit de eerste sectie. Vervang <your-password> door het wachtwoord dat u eerder in deze handleiding hebt ingesteld. Voeg ook de Database=bookshelf waarde toe aan de verbindingsreeks.
```
dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
```

Een auteurentiteit toevoegen met behulp van .dab add

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

API testen met de lokale database

Start nu het hulpprogramma voor het maken van gegevens-API's om te controleren of uw configuratiebestanden tijdens de ontwikkeling worden samengevoegd.

Gebruik dab start dit om het hulpprogramma uit te voeren en API-eindpunten voor uw entiteit te maken.
```
dab start
```
De uitvoer van het hulpprogramma moet het adres bevatten dat moet worden gebruikt om naar de actieve API te navigeren.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Aanbeveling

In dit voorbeeld wordt de toepassing uitgevoerd op localhost poort 5000. Uw actieve toepassing heeft mogelijk een ander adres en een andere poort.
Probeer eerst handmatig de API door een GET-aanvraag naar /api/Author uit te voeren.

Aanbeveling

In dit voorbeeld is https://localhost:5000/api/Authorde URL. U kunt naar deze URL navigeren met behulp van uw webbrowser.
Navigeer vervolgens naar de Swagger-documentatiepagina op /swagger.

Aanbeveling

In dit voorbeeld is https://localhost:5000/swaggerde URL. Nogmaals, u kunt naar deze URL navigeren met behulp van uw webbrowser.

Volgende stap

REST-eindpunten

Feedback

Is deze pagina nuttig?

Last updated on 2025-07-17