Поделиться через

Сборка и запуск построителя API данных из исходного кода

  • Статья

Построитель API данных (DAB) — это проект с открытым исходным кодом, размещенный на сайте GitHub. В любое время можно скачать исходный код, изменить его и запустить проект непосредственно из исходного кода. Это руководство содержит все шаги, необходимые для сборки проекта непосредственно из его исходного кода.

Предварительные требования

Вилка и клонирование репозитория

Начните с создания собственной вилки репозитория azure/data-api-builder GitHub. Эта вилка позволяет сохранять собственные изменения. Если это так, вы всегда можете открыть запрос на вытягивание и предложить изменения в вышестоящий репозитории.

  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 , подсистема запустится в любом случае, но она не сможет ничего обслуживать.

См. также