ソース コードから Data API ビルダーをビルドして実行する

データ API ビルダー (DAB) は、GitHub でホストされているオープンソース プロジェクトです。 いつでも、ソース コードをダウンロードし、コードを変更し、ソースから直接プロジェクトを実行できます。 このガイドには、ソース コードから直接プロジェクトをビルドするために必要なすべての手順が含まれています。

前提条件

• GitHub アカウント
• Git
  • このチュートリアルでは、Git コマンドとツールに関する基本的な知識を前提としています。
• .NET 8

リポジトリをフォークして複製する

まず、GitHub リポジトリの独自のフォークを azure/data-api-builder 作成します。 このフォークを使用すると、独自の変更を保持できます。 そう選択した場合は、いつでも pull request を開き、アップストリーム リポジトリへの変更を提案できます。

1. https://github.com/azure/data-api-builder/fork に移動します。

2. 自分のアカウントまたはorganization内のリポジトリのフォークを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があることを前提としたサンプル構成です。 実行しない場合は、サンプル データを使用して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 場合、エンジンは起動しますが、何も提供できません。

関連コンテンツ

• azure/data-api-builder GitHub で
• Docker コンテナーでの実行