Dela via

Skapa och köra data-API-byggare från källkod

Data API Builder (DAB) är ett projekt med öppen källkod som finns på GitHub. När som helst kan du ladda ned källkoden, ändra koden och köra projektet direkt från källan. Den här guiden innehåller alla steg som krävs för att skapa projektet direkt från källkoden.

Förutsättningar

  • GitHub-konto
  • Git
    • Den här självstudien förutsätter grundläggande kunskaper om Git-kommandon och -verktyg.
  • .NET 8

Förgrena och klona lagringsplatsen

Kom igång genom att skapa en egen förgrening av azure/data-api-builder GitHub-lagringsplatsen. Med den här förgreningen kan du bevara dina egna ändringar. Om du väljer det kan du alltid öppna en pull-begäran och föreslå ändringarna i den överordnade lagringsplatsen.

  1. Gå till https://github.com/azure/data-api-builder/fork.

  2. Skapa en förgrening av lagringsplatsen i ditt eget konto eller din organisation. Vänta tills förgreningsåtgärden har slutförts innan du fortsätter.

  3. Öppna en ny terminal.

  4. Klona gaffeln.

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

    Tips/Råd

    Du kan också öppna förgreningen eller den ursprungliga lagringsplatsen som ett GitHub Codespace.

  5. src/Azure.DataApiBuilder.sln Skapa lösningen.

    dotnet build src/Azure.DataApiBuilder.sln

Kör motorn

Lösningen Azure.DataApiBuilder innehåller flera projekt. Om du vill köra verktyget från källan kör du Azure.DataApiBuilder.Service projektet som skickar in en konfigurationsfil.

  1. I rotkatalogen skapar du en ny fil med namnet dab-config.json.

    Tips/Råd

    .gitignore-filen ignorerar automatiskt alla DAB-konfigurationsfiler.

  2. Lägg till följande innehåll i konfigurationsfilen.

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

    Viktigt!

    Det här är en exempelkonfiguration som förutsätter att du har en SQL Server tillgänglig på den lokala datorn. Om du inte gör det kan du köra en Docker-container för SQL Server med dina exempeldata. Mer information finns i skapa exempeldata.

  3. Kör projektet src/Service/Azure.DataApiBuilder.Service.csproj. --ConfigFileName Använd argumentet för att ange konfigurationsfilen som skapades i föregående steg.

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

    Tips/Råd

    Data-API-buildermotorn försöker läsa in konfigurationen dab-config.json från filen i samma mapp, om den finns. Om det inte finns någon dab-config.json fil startar motorn ändå, men den kommer inte att kunna hantera något.

Relaterat innehåll