Partager via

Générer et exécuter le générateur d’API de données à partir du code source

  • Article

Data API Builder (DAB) est un projet open source hébergé sur GitHub. À tout moment, vous pouvez télécharger le code source, modifier le code et exécuter le projet directement à partir de la source. Ce guide comprend toutes les étapes nécessaires pour générer le projet directement à partir de son code source.

Prérequis

Duplication et clonage du référentiel

Commencez par créer votre propre fork du azure/data-api-builder dépôt GitHub. Cette duplication vous permet de conserver vos propres modifications. Si vous le souhaitez, vous pouvez toujours ouvrir une demande de tirage et suggérer les modifications apportées au dépôt amont.

  1. Accédez à https://github.com/azure/data-api-builder/fork.

  2. Create une duplication du dépôt dans votre propre compte ou organization. Attendez que l’opération de duplication se termine avant de continuer.

  3. Ouvrez un nouveau terminal.

  4. Clonez la duplication.

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

    Conseil

    Vous pouvez également ouvrir la duplication ou le dépôt d’origine en tant que GitHub Codespace.

  5. Générez la src/Azure.DataApiBuilder.sln solution.

    dotnet build src/Azure.DataApiBuilder.sln

Exécuter le moteur

La Azure.DataApiBuilder solution inclut plusieurs projets. Pour exécuter l’outil à partir de la source, exécutez le Azure.DataApiBuilder.Service projet en passant un fichier de configuration.

  1. Dans le répertoire racine, créez un fichier nommé dab-config.json.

    Conseil

    Le fichier .gitignore ignore automatiquement tous les fichiers de configuration DAB.

  2. Ajoutez le contenu suivant au fichier de configuration.

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

    Important

    Il s’agit d’un exemple de configuration qui suppose que vous disposez d’un SQL Server disponible sur votre ordinateur local. Si ce n’est pas le cas, vous pouvez exécuter un conteneur Docker pour SQL Server avec vos exemples de données. Pour plus d’informations, consultez Création d’exemples de données.

  3. Exécutez le projet src/Service/Azure.DataApiBuilder.Service.csproj. Utilisez l’argument --ConfigFileName pour spécifier le fichier de configuration créé à l’étape précédente.

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

    Conseil

    Le moteur du générateur d’API de données tente de charger la configuration à partir du dab-config.json fichier dans le même dossier, le cas échéant. S’il n’y a pas dab-config.json de fichier, le moteur démarre de toute façon, mais il ne pourra rien servir.

Contenu connexe