Sdílet prostřednictvím

Sestavení a spuštění Tvůrce rozhraní Data API ze zdrojového kódu

  • Článek

Data API Builder (DAB) je opensourcový projekt hostovaný na GitHubu. Kdykoli si můžete stáhnout zdrojový kód, upravit ho a spustit projekt přímo ze zdroje. Tato příručka obsahuje všechny kroky potřebné k sestavení projektu přímo ze zdrojového kódu.

Požadavky

Vytvoření forku a klonování úložiště

Začněte vytvořením vlastního azure/data-api-builder forku úložiště GitHub. Tento fork umožňuje zachovat vlastní změny. Pokud se tak rozhodnete, můžete vždy otevřít žádost o přijetí změn a navrhnout změny v upstreamovém úložišti.

  1. Přejděte na adresu https://github.com/azure/data-api-builder/fork.

  2. Create fork úložiště ve vašem vlastním účtu nebo organizaci. Než budete pokračovat, počkejte na dokončení operace forkingu.

  3. Otevřete nový terminál.

  4. Naklonujte fork.

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

    Tip

    Případně můžete fork nebo původní úložiště otevřít jako GitHub Codespace.

  5. src/Azure.DataApiBuilder.sln Sestavte řešení.

    dotnet build src/Azure.DataApiBuilder.sln

Spuštění modulu

Řešení Azure.DataApiBuilder zahrnuje několik projektů. Pokud chcete nástroj spustit ze zdroje, spusťte Azure.DataApiBuilder.Service projekt, který předává konfigurační soubor.

  1. V kořenovém adresáři vytvořte nový soubor s názvem dab-config.json.

    Tip

    Soubor .gitignore automaticky ignoruje všechny konfigurační soubory DAB.

  2. Do konfiguračního souboru přidejte následující obsah.

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

    Důležité

    Jedná se o ukázkovou konfiguraci, která předpokládá, že máte na místním počítači k dispozici SQL Server. Pokud ne, můžete spustit kontejner Dockeru pro SQL Server s ukázkovými daty. Další informace najdete v tématu Vytváření ukázkových dat.

  3. src/Service/Azure.DataApiBuilder.Service.csproj Spusťte projekt. Pomocí argumentu --ConfigFileName zadejte konfigurační soubor vytvořený v předchozím kroku.

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

    Tip

    Modul Tvůrce rozhraní API pro data se pokusí načíst konfiguraci ze dab-config.json souboru ve stejné složce, pokud je k dispozici. Pokud neexistuje žádný dab-config.json soubor, modul se přesto spustí, ale nebude moct nic obslouužit.

Související obsah