Udostępnij za pośrednictwem

Kompilowanie i uruchamianie konstruktora interfejsu API danych na podstawie kodu źródłowego

  • Artykuł

Konstruktor interfejsu API danych (DAB) to projekt typu open source hostowany w usłudze GitHub. W dowolnym momencie możesz pobrać kod źródłowy, zmodyfikować kod i uruchomić projekt bezpośrednio ze źródła. Ten przewodnik zawiera wszystkie kroki niezbędne do skompilowania projektu bezpośrednio z jego kodu źródłowego.

Wymagania wstępne

Rozwidlenie i sklonowanie repozytorium

Rozpocznij od utworzenia własnego rozwidlenia azure/data-api-builder repozytorium GitHub. To rozwidlenie umożliwia utrwalanie własnych zmian. Jeśli tak wybierzesz, zawsze możesz otworzyć żądanie ściągnięcia i zasugerować zmiany w repozytorium nadrzędnym.

  1. Przejdź do adresu https://github.com/azure/data-api-builder/fork.

  2. Twórca rozwidlenie repozytorium we własnym koncie lub organizacji. Przed kontynuowaniem poczekaj na zakończenie operacji rozwidlania.

  3. Otwórz nowy terminal.

  4. Sklonuj rozwidlenie.

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

    Porada

    Alternatywnie możesz otworzyć rozwidlenie lub oryginalne repozytorium jako repozytorium GitHub Codespace.

  5. Skompiluj src/Azure.DataApiBuilder.sln rozwiązanie.

    dotnet build src/Azure.DataApiBuilder.sln

Uruchamianie aparatu

Rozwiązanie Azure.DataApiBuilder zawiera wiele projektów. Aby uruchomić narzędzie ze źródła, uruchom Azure.DataApiBuilder.Service projekt przekazujący plik konfiguracji.

  1. W katalogu głównym utwórz nowy plik o nazwie dab-config.json.

    Porada

    Plik .gitignore automatycznie ignoruje wszystkie pliki konfiguracji daB.

  2. Dodaj następującą zawartość do pliku konfiguracji.

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

    Ważne

    Jest to przykładowa konfiguracja, która zakłada, że masz SQL Server dostępne na komputerze lokalnym. Jeśli nie, możesz uruchomić kontener platformy Docker dla SQL Server z przykładowymi danymi. Aby uzyskać więcej informacji, zobacz tworzenie przykładowych danych.

  3. src/Service/Azure.DataApiBuilder.Service.csproj Uruchom projekt. Użyj argumentu --ConfigFileName , aby określić plik konfiguracji utworzony w poprzednim kroku.

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

    Porada

    Aparat konstruktora interfejsu API danych spróbuje załadować konfigurację z dab-config.json pliku w tym samym folderze, jeśli jest obecny. Jeśli nie dab-config.json ma pliku, aparat zostanie uruchomiony mimo to, ale nie będzie w stanie służyć niczego.

Zawartość pokrewna