Freigeben über

Erstellen und Ausführen des Daten-API-Generators aus Quellcode

Der Daten-API-Generator (DAB) ist ein Open-Source-Projekt, das auf GitHub gehostet wird. Sie können den Quellcode jederzeit herunterladen, den Code ändern und das Projekt direkt aus der Quelle ausführen. Dieser Leitfaden enthält alle Schritte, die erforderlich sind, um das Projekt direkt aus dem Quellcode zu erstellen.

Voraussetzungen

  • GitHub-Konto
  • Git
    • In diesem Lernprogramm wird eine grundlegende Vertrautheit mit Git-Befehlen und -Tools vorausgesetzt.
  • .NET 8

Forken und Klonen des Repositorys

Beginnen Sie, indem Sie einen eigenen Fork des azure/data-api-builder GitHub-Repositorys erstellen. Mit diesem Fork können Sie Ihre eigenen Änderungen beibehalten. Wenn Sie dies auswählen, können Sie immer eine Pull-Anforderung öffnen und die Änderungen am Upstream-Repository vorschlagen.

  1. Navigiere zu https://github.com/azure/data-api-builder/fork.

  2. Erstellen Sie einen Fork des Repositorys in Ihrem Account oder Ihrer Organisation. Warten Sie, bis der Fork-Vorgang abgeschlossen ist, bevor Sie fortfahren.

  3. Öffnen Sie ein neues Terminal.

  4. Klonen Sie den Fork.

    git clone https://github.com/<your-username>/data-api-builder.git

    Tipp

    Alternativ können Sie den Fork oder das ursprüngliche Repository als GitHub Codespace öffnen.

  5. Erstellen Sie die src/Azure.DataApiBuilder.sln Lösung.

    dotnet build src/Azure.DataApiBuilder.sln

Ausführen des Moduls

Die Azure.DataApiBuilder Lösung enthält mehrere Projekte. Um das Tool aus der Quelle auszuführen, führen Sie das Azure.DataApiBuilder.Service Projekt aus, das eine Konfigurationsdatei übergibt.

  1. Erstellen Sie im Stammverzeichnis eine neue Datei mit dem Namen dab-config.json.

    Tipp

    Die GITIGnore-Datei ignoriert automatisch alle DAB-Konfigurationsdateien.

  2. Fügen Sie der Konfigurationsdatei den folgenden Inhalt hinzu.

    {
  "$schema": "https://github.com/Azure/data-api-builder/releases/latest/download/dab.draft.schema.json",
  "data-source": {
    "database-type": "mssql",
    "connection-string": "Server=localhost,1433;Initial Catalog=Library;User Id=sa;Password=<your-password>;TrustServerCertificate=true;"
  },
  "entities": {
    "book": {
      "source": "dbo.Books",
      "permissions": [
        {
          "actions": [
            "read"
          ],
          "role": "anonymous"
        }
      ]
    }
  }
}

    Von Bedeutung

    Dies ist eine Beispielkonfiguration, die davon ausgeht, dass Auf Ihrem lokalen Computer ein SQL Server verfügbar ist. Wenn Sie dies nicht tun, können Sie einen Docker-Container für SQL Server mit Ihren Beispieldaten ausführen. Weitere Informationen finden Sie unter Erstellen von Beispieldaten.

  3. Führen Sie das src/Service/Azure.DataApiBuilder.Service.csproj Projekt aus. Verwenden Sie das --ConfigFileName Argument, um die im vorherigen Schritt erstellte Konfigurationsdatei anzugeben.

    dotnet run --project src/Service/Azure.DataApiBuilder.Service.csproj --ConfigFileName ../../dab-config.json

    Tipp

    Das Daten-API-Generator-Modul versucht, die Konfiguration aus der dab-config.json Datei im selben Ordner zu laden, falls vorhanden. Wenn keine dab-config.json Datei vorhanden ist, wird die Engine trotzdem gestartet, kann aber nichts ausliefern.

Verwandte Inhalte

  • Last updated on