共用方式為


從原始碼建置和執行資料 API 產生器

數據 API 產生器 (DAB) 是裝載在 GitHub 上的開放原始碼專案。 您可以隨時下載原始程式碼、修改程式碼,然後直接從來源執行專案。 本指南包含直接從原始程式碼建置專案所需的所有步驟。

必要條件

派生和複製存放庫

開始建立自己的 GitHub 存放庫分支 azure/data-api-builder 。 此分支可讓您保存自己的變更。 如果您選擇的話,您一律可以開啟提取要求,並建議上游存放庫的變更。

  1. 瀏覽至 https://github.com/azure/data-api-builder/fork

  2. Create 您自己的帳戶或組織中的存放庫分支。 等候分叉作業完成,再繼續進行。

  3. 開啟新的終端機。

  4. 複製分叉。

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

    提示

    或者,您可以將分支或原始存放庫開啟為 GitHub Codespace。

  5. 建置 src/Azure.DataApiBuilder.sln 方案。

    dotnet build src/Azure.DataApiBuilder.sln
    

執行引擎

方案 Azure.DataApiBuilder 包含多個專案。 若要從來源執行工具,請 Azure.DataApiBuilder.Service 執行傳入組態檔的專案。

  1. 在根目錄中,建立名為 dab-config.json的新檔案。

    提示

    .gitignore 檔案會自動忽略任何 DAB 組態檔。

  2. 將下列內容新增至組態檔。

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

    重要

    這是假設您在本機電腦上有 SQL Server 可用的範例組態。 如果沒有,您可以使用範例數據來執行 Docker 容器,以 SQL Server。 如需詳細資訊,請參閱 建立範例數據

  3. src/Service/Azure.DataApiBuilder.Service.csproj執行專案。 --ConfigFileName使用 自變數來指定在上一個步驟中建立的組態檔。

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

    提示

    如果有的話,數據 API 產生器引擎會嘗試從 dab-config.json 相同資料夾中的檔案載入組態。 dab-config.json如果沒有檔案,引擎仍然會啟動,但無法提供任何專案。