從原始碼建置並執行 Data API 建構器

Data API 建構器(DAB)是一個開源專案,託管於 GitHub。 你隨時都可以下載原始碼、修改程式碼,並直接從原始碼執行專案。 本指南包含所有直接從原始碼建構專案所需的步驟。

先決條件

分支並克隆儲存庫

開始吧,先建立你自己的 GitHub 倉庫分支 azure/data-api-builder 。 這個分支允許你持續執行自己的變更。 如果你願意,隨時可以開啟拉取請求,並向上游儲存庫建議修改內容。

  1. 導航至 https://github.com/azure/data-api-builder/fork

  2. 在你的帳號或組織中建立一個倉庫的派生。 等分叉操作完成後再繼續。

  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 的範例配置。 如果沒有其他選擇,你可以運行一個用於 SQL Server 並包含範例資料的 Docker 容器。 欲了解更多資訊,請參閱 建立樣本資料

  3. 執行 src/Service/Azure.DataApiBuilder.Service.csproj 專案。 使用 --ConfigFileName 參數指定前一步建立的設定檔。

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

    小提示

    Data API 建構引擎會嘗試從 dab-config.json 同一資料夾中的設定檔載入(如果有的話)。 如果沒有 dab-config.json 檔案,引擎還是會啟動,但無法提供任何服務。