Schnellstart: Verwenden des Daten-API-Generators mit MySQL

2025-06-11

In dieser Schnellstartanleitung erstellen Sie eine Reihe von Konfigurationsdateien des Daten-API-Generators für eine lokale MySQL-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, für die jeweils keine Kosten anfallen. Weitere Informationen finden Sie unter Monatlich enthaltene Speicherkapazität und Kernstunden für GitHub-Konten.

Installieren des Daten-API-Generators CLI

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 Argument --global 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
```
Stellen Sie sicher, dass das Tool mit dotnet tool list dem --global Argument installiert ist.
```
dotnet tool list --global
```

Konfigurieren der lokalen Datenbank

Beginnen Sie, indem Sie die lokale Datenbank konfigurieren und ausführen. Anschließend können Sie einen neuen Container mit Beispieldaten seeden.

Rufen Sie die neueste Kopie des mysql:8 Containerimages von Docker Hub ab.
```
docker pull mysql:8
```
Starten Sie den Docker-Container, indem Sie das Kennwort und den Veröffentlichungsport 3306 festlegen. Ersetzen Sie <your-password> durch ein benutzerdefiniertes Kennwort.
```
docker run \
    --publish 3306:3306 \
    --env "MYSQL_ROOT_PASSWORD=<your-password>" \
    --detach \
    mysql:8
```
Stellen Sie mithilfe Ihrer bevorzugten Datenverwaltungsumgebung eine Verbindung mit Ihrer lokalen Datenbank her. Beispiele sind, aber nicht beschränkt auf : MySQL Workbench, Azure Data Studio und die MySQL-Shell für Visual Studio Code.

Tipp

Wenn Sie das Standardnetzwerk für Ihre Docker-Linux-Containerimages verwenden, lautet die Verbindungszeichenfolge wahrscheinlich Server=localhost;Port=3306;Uid=root;Pwd=<your-password>;. Ersetzen Sie <your-password> es durch das Kennwort, das Sie zuvor festgelegt haben.
Erstellen Sie eine neue bookshelf Datenbank, und verwenden Sie die Datenbank für Ihre verbleibenden Abfragen.
```
CREATE DATABASE IF NOT EXISTS bookshelf;

USE bookshelf;
```

Erstellen Sie eine neue dbo.authors Tabelle und füllen 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

Erstellen Sie eine Basiskonfigurationsdatei mit der DAB CLI. Fügen Sie dann eine Entwicklungskonfigurationsdatei mit Ihren aktuellen Anmeldeinformationen hinzu.

Erstellen Sie eine typische Konfigurationsdatei mithilfe von dab init. Fügen Sie das --connection-string Argument mit ihrer Datenbankverbindungszeichenfolge aus dem ersten Abschnitt hinzu. Ersetzen Sie <your-password> es durch das Kennwort, das Sie weiter oben in diesem Handbuch festgelegt haben. Fügen Sie außerdem den Database=bookshelf Wert zur Verbindungszeichenfolge hinzu.
```
dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"
```

Fügen Sie eine Author-Entität mithilfe von dab add.

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

Beobachten Sie Ihre aktuelle dab-config.json Konfigurationsdatei. Die Datei sollte eine grundlegende Implementierung Ihrer API mit einer einzelnen Entität, einem REST-API-Endpunkt und einem GraphQL-Endpunkt enthalten.

Testen der API mit der lokalen Datenbank

Starten Sie nun das Daten-API-Generator-Tool, 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 Organisation 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 Port 5000 ausgeführtlocalhost. Ihre ausgeführte Anwendung verfügt möglicherweise über eine andere Adresse und einen anderen Port.
Versuchen Sie zunächst die API manuell, indem Sie eine GET-Anforderung an /api/Author.

Tipp

In diesem Beispiel wäre die URL https://localhost:5000/api/Author. Sie können mit Ihrem Webbrowser zu dieser URL navigieren.
Navigieren Sie als Nächstes zur Dokumentationsseite von Swagger unter /swagger.

Tipp

In diesem Beispiel wäre die URL https://localhost:5000/swagger. Auch hier können Sie mithilfe Ihres Webbrowsers zu dieser URL navigieren.

Nächster Schritt

REST-Endpunkte

Freigeben über