Schnellstart: Verwenden des Daten-API-Generators mit SQL

Artikel
05/14/2024

In dieser Schnellstartanleitung erstellen Sie eine Reihe von Daten-API-Konfigurationsdateien für eine lokale SQL-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 mit allen bereits installierten Entwicklervoraussetzungen öffnen. 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 Enthaltene Speicher- und Kernstunden für GitHub-Konten.

Installieren der Daten-API-Generator-CLI

Installieren Sie das Microsoft.DataApiBuilder Paket aus 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, indem Sie die lokale Datenbank konfigurieren und ausführen, um die relevanten Anmeldeinformationen festzulegen. Anschließend können Sie die Datenbank mit Beispieldaten seeden.

Rufen Sie die neueste Kopie des mcr.microsoft.com/mssql/server:2022-latest Containerimages von Docker Hub ab.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Starten Sie den Docker-Container, indem Sie das Kennwort festlegen, den Endbenutzerlizenzvertrag (EULA) akzeptieren und Port 1433 veröffentlichen. Ersetzen Sie durch <your-password> ein benutzerdefiniertes Kennwort.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Stellen Sie mithilfe Ihrer bevorzugten Datenverwaltungsumgebung eine Verbindung mit Ihrer lokalen Datenbank her. Beispiele hierfür sind unter anderem: SQL Server Management Studio, Azure Data Studio und die SQL Server-Erweiterung für Visual Studio Code.

Tipp

Wenn Sie standardnetzwerke für Ihre Docker Linux-Containerimages verwenden, ist Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;die Verbindungszeichenfolge wahrscheinlich . Ersetzen Sie durch <your-password> das zuvor festgelegte Kennwort.
Create eine neue bookshelf Datenbank und verwenden Sie die Datenbank für Ihre verbleibenden Abfragen.
```
DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO
```

Create eine neue dbo.authors Tabelle aus, und führen Sie ein Seeding für die Tabelle mit Basisdaten durch.

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

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 durch <your-password> das Kennwort, das Sie weiter oben in diesem Handbuch festgelegt haben. Fügen Sie außerdem den Database=bookshelf Wert zum Verbindungszeichenfolge hinzu.
```
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;"
```

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

dab add Author --source "dbo.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 verfügt möglicherweise über eine andere Adresse und einen anderen Port.
Probieren Sie zunächst die API manuell aus, indem Sie eine GET-Anforderung an ausstellen /api/Author.

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 unter zur Swagger-Dokumentationsseite /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

Schnellstart: Bereitstellen des Daten-API-Generators in Azure

Freigeben über