Membangun dan menjalankan penyusun API Data dari kode sumber

Penyusun API Data (DAB) adalah proyek sumber terbuka yang dihosting di GitHub. Kapan saja, Anda dapat mengunduh kode sumber, memodifikasi kode, dan menjalankan proyek langsung dari sumber. Panduan ini mencakup semua langkah yang diperlukan untuk membangun proyek langsung dari kode sumbernya.

Prasyarat

Fork dan salin repositori

Mulailah dengan membuat fork azure/data-api-builder repositori GitHub Anda sendiri. Fork ini memungkinkan Anda untuk mempertahankan perubahan Anda sendiri. Jika Anda mau, Anda selalu dapat membuka permintaan pull dan menyarankan perubahan ke repositori upstream.

  1. Pindah ke https://github.com/azure/data-api-builder/fork.

  2. Buat fork repositori di akun atau organisasi Anda sendiri. Tunggu hingga operasi forking selesai sebelum melanjutkan.

  3. Buka terminal baru.

  4. Kloning fork.

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

    Petunjuk / Saran

    Atau, Anda dapat membuka fork atau repositori asli sebagai GitHub Codespace.

  5. Bangun solusinya src/Azure.DataApiBuilder.sln .

    dotnet build src/Azure.DataApiBuilder.sln
    

Jalankan mesin

Solusi Azure.DataApiBuilder mencakup berbagai proyek. Untuk menjalankan alat dari sumber, jalankan proyek Azure.DataApiBuilder.Service dengan memberikan file konfigurasi.

  1. Di direktori akar, buat file baru bernama dab-config.json.

    Petunjuk / Saran

    File .gitignore secara otomatis mengabaikan file konfigurasi DAB apa pun.

  2. Tambahkan konten berikut ke file konfigurasi.

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

    Penting

    Ini adalah konfigurasi sampel yang mengasumsikan Anda memiliki SQL Server yang tersedia di komputer lokal Anda. Jika tidak, Anda dapat menjalankan kontainer Docker untuk SQL Server dengan data sampel Anda. Untuk informasi selengkapnya, lihat membuat data sampel.

  3. Jalankan proyek src/Service/Azure.DataApiBuilder.Service.csproj. --ConfigFileName Gunakan argumen untuk menentukan file konfigurasi yang dibuat pada langkah sebelumnya.

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

    Petunjuk / Saran

    Mesin pembuat API Data mencoba memuat konfigurasi dari dab-config.json file di folder yang sama, jika ada. Jika tidak ada file dab-config.json, mesin memang akan mulai tetapi tidak akan dapat melayani apa pun.