Condividi tramite

Compilare ed eseguire Generatore API dati dal codice sorgente

  • Articolo

Il generatore di API dati (DAB) è un progetto open source ospitato in GitHub. In qualsiasi momento, è possibile scaricare il codice sorgente, modificare il codice ed eseguire il progetto direttamente dall'origine. Questa guida include tutti i passaggi necessari per compilare il progetto direttamente dal codice sorgente.

Prerequisiti

  • Account GitHub
  • Git
    • Questa esercitazione presuppone una conoscenza di base dei comandi e degli strumenti Git.
  • .NET 8

Creare una copia tramite fork e clonare il repository

Per iniziare, creare un fork personalizzato del azure/data-api-builder repository GitHub. Questo fork consente di rendere persistenti le proprie modifiche. In questo caso, è sempre possibile aprire una richiesta pull e suggerire le modifiche al repository upstream.

  1. Accedere a https://github.com/azure/data-api-builder/fork.

  2. Create un fork del repository nell'account o nell'organizzazione. Attendere il completamento dell'operazione di fork prima di continuare.

  3. Aprire un nuovo terminale.

  4. Clonare il fork.

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

    Suggerimento

    In alternativa, è possibile aprire il fork o il repository originale come GitHub Codespace.

  5. Compilare la src/Azure.DataApiBuilder.sln soluzione.

    dotnet build src/Azure.DataApiBuilder.sln

Eseguire il motore

La Azure.DataApiBuilder soluzione include più progetti. Per eseguire lo strumento dall'origine, eseguire il Azure.DataApiBuilder.Service progetto passando un file di configurazione.

  1. Nella directory radice creare un nuovo file denominato dab-config.json.

    Suggerimento

    Il file con estensione gitignore ignora automaticamente tutti i file di configurazione DAB.

  2. Aggiungere il contenuto seguente al file di configurazione.

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

    Importante

    Si tratta di una configurazione di esempio che presuppone la disponibilità di un SQL Server nel computer locale. In caso contrario, è possibile eseguire un contenitore Docker per SQL Server con i dati di esempio. Per altre informazioni, vedere Creazione di dati di esempio.

  3. Eseguire il src/Service/Azure.DataApiBuilder.Service.csproj progetto. Usare l'argomento --ConfigFileName per specificare il file di configurazione creato nel passaggio precedente.

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

    Suggerimento

    Il motore di Generatore API dati tenterà di caricare la configurazione dal dab-config.json file nella stessa cartella, se presente. Se non è presente alcun dab-config.json file, il motore verrà avviato comunque, ma non sarà in grado di servire nulla.

Contenuti correlati