Schnellstart: Verwenden des Daten-API-Generators mit PostgreSQL

Artikel
05/14/2024

In dieser Schnellstartanleitung erstellen Sie eine Reihe von Daten-API-Konfigurationsdateien für eine lokale PostgreSQL-Datenbank.

Voraussetzungen

Docker
.NET 8
Ein Datenverwaltungsclient
- Wenn Sie keinen Client installiert haben, installieren Sie Azure Data Studio.

Tipp

Alternativ können Sie diese Schnellstartanleitung in GitHub Codespaces öffnen, wobei alle Entwicklervoraussetzungen bereits installiert sind. Bringen Sie einfach Ihr eigenes Azure-Abonnement mit. GitHub-Konten enthalten eine Berechtigung für Speicher und Kernstunden ohne Kosten. Weitere Informationen finden Sie unter Eingeschlossener Speicher und Kernstunden für GitHub-Konten.

Installieren der Cli des Daten-API-Generators

Installieren Sie das Microsoft.DataApiBuilder Paket von NuGet als .NET-Tool.

Verwenden Sie dotnet tool install , um die neueste Version von Microsoft.DataApiBuilder mit dem --global -Argument zu installieren.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Hinweis

Wenn das Paket bereits installiert ist, aktualisieren Sie das Paket stattdessen mithilfe von dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Vergewissern Sie sich, dass das Tool mit dotnet tool list installiert ist, indem Sie das --global Argument verwenden.
```
dotnet tool list --global
```

Konfigurieren der lokalen Datenbank

Beginnen Sie mit dem Konfigurieren und Ausführen der lokalen Datenbank. Anschließend können Sie einen neuen Container mit Beispieldaten seeden.

Rufen Sie die neueste Kopie des postgres:16 Containerimages von Docker Hub ab.
```
docker pull postgres:16
```
Starten Sie den Docker-Container, indem Sie das Kennwort festlegen und Port 5432 veröffentlichen. Ersetzen Sie durch <your-password> ein benutzerdefiniertes Kennwort.
```
docker run \
    --publish 5432:5432 \
    --env "POSTGRES_PASSWORD=<your-password>" \
    --detach \
    postgres:16
```
Stellen Sie mithilfe Ihrer bevorzugten Datenverwaltungsumgebung eine Verbindung mit Ihrer lokalen Datenbank her. Beispiele sind unter anderem : pgAdmin, Azure Data Studio und die PostgreSQL-Erweiterung für Visual Studio Code.

Tipp

Wenn Sie das Standardnetzwerk für Ihre Docker Linux-Containerimages verwenden, ist der Verbindungszeichenfolge wahrscheinlich Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;. Ersetzen Sie <your-password> durch das zuvor festgelegte Kennwort.

Erstellen Sie eine neue bookshelf-Datenbank.

DROP DATABASE IF EXISTS bookshelf;

CREATE DATABASE bookshelf;

Create eine neue dbo.authors Tabelle aus, und erstellen Sie die Tabelle mit Basisdaten.

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

Erstellen von Konfigurationsdateien

Create eine Baselinekonfigurationsdatei mithilfe der DAB CLI. Fügen Sie dann eine Entwicklungskonfigurationsdatei mit Ihren aktuellen Anmeldeinformationen hinzu.

Create eine typische Konfigurationsdatei mit dab init. Fügen Sie das --connection-string Argument mit Ihrer Datenbank Verbindungszeichenfolge aus dem ersten Abschnitt hinzu. Ersetzen Sie <your-password> durch das Kennwort, das Sie zuvor in diesem Handbuch festgelegt haben. Fügen Sie außerdem den Database=bookshelf Wert dem Verbindungszeichenfolge hinzu.
```
dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
```

Fügen Sie mithilfe dab addvon eine Author-Entität hinzu.

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

Testen der API mit der lokalen Datenbank

Starten Sie nun das Daten-API-Generatortool, um zu überprüfen, ob Ihre Konfigurationsdateien während der Entwicklung zusammengeführt werden.

Verwenden Sie dab start , um das Tool auszuführen und API-Endpunkte für Ihre Entität zu erstellen.
```
dab start
```
Die Ausgabe des Tools sollte die Adresse enthalten, die zum Navigieren zur ausgeführten API verwendet werden soll.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Tipp

In diesem Beispiel wird die Anwendung an localhost Port 5000 ausgeführt. Ihre ausgeführte Anwendung hat möglicherweise eine andere Adresse und einen anderen Port.
Probieren Sie zunächst die API manuell aus, indem Sie eine GET-Anforderung an /api/Authorausstellen.

Tipp

In diesem Beispiel lautet https://localhost:5000/api/Authordie URL . Sie können mit Ihrem Webbrowser zu dieser URL navigieren.
Navigieren Sie als Nächstes zur Swagger-Dokumentationsseite unter /swagger.

Tipp

In diesem Beispiel lautet https://localhost:5000/swaggerdie URL . Auch hier können Sie mit Ihrem Webbrowser zu dieser URL navigieren.

Nächster Schritt

REST-Endpunkte

Freigeben über