Freigeben über

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

  • Artikel

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

Voraussetzungen

Abteilen und Klonen des Repositoriums

Erstellen Sie zunächst Einen eigenen Fork des azure/data-api-builder GitHub-Repositorys. Mit diesem Fork können Sie Ihre eigenen Änderungen beibehalten. Wenn Sie dies auswählen, können Sie immer einen Pull Request öffnen und die Änderungen am Upstream-Repository vorschlagen.

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

  2. Create einen Fork des Repositorys in Ihrem eigenen Konto oder organization. Warten Sie, bis der Forkingvorgang 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 Projektmappe.

    dotnet build src/Azure.DataApiBuilder.sln

Ausführen der Engine

Die Azure.DataApiBuilder Projektmappe enthält mehrere Projekte. Um das Tool von der Quelle aus auszuführen, führen Sie das Azure.DataApiBuilder.Service Projekt aus, und übergeben Sie eine Konfigurationsdatei.

  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"
        }
      ]
    }
  }
}

    Wichtig

    Dies ist eine Beispielkonfiguration, bei der davon ausgegangen wird, dass auf Ihrem lokalen Computer ein SQL Server verfügbar ist. Andernfalls 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 konfigurationsdatei anzugeben, die im vorherigen Schritt erstellt wurde.

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

    Tipp

    Die Daten-API-Generator-Engine versucht, die Konfiguration aus der dab-config.json Datei im selben Ordner zu laden, sofern vorhanden. Wenn keine dab-config.json Datei vorhanden ist, wird die Engine trotzdem gestartet, aber sie kann nichts bereitstellen.

Verwandte Inhalte