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

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

Необходимые условия

Сделайте форк и клонируйте репозиторий

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

  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 на локальном компьютере. Если этого не сделать, можно запустить контейнер Docker для SQL Server с примерами данных. Дополнительные сведения см. в статье о создании примеров данных.

  3. Запустите проект src/Service/Azure.DataApiBuilder.Service.csproj. --ConfigFileName Используйте аргумент, чтобы указать файл конфигурации, созданный на предыдущем шаге.

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

    Подсказка

    Движок Data API Builder пытается загрузить конфигурацию из файла dab-config.json в той же папке, если он присутствует. Если нет dab-config.json файла, движок запускается в любом случае, но не сможет ничего обслуживать.

Связанный контент

  • Last updated on