Compartir a través de

Compilación y ejecución del generador de API de datos desde el código fuente

  • Artículo

Data API Builder (DAB) es un proyecto de código abierto hospedado en GitHub. En cualquier momento, puede descargar el código fuente, modificar el código y ejecutar el proyecto directamente desde el origen. En esta guía se incluyen todos los pasos necesarios para compilar el proyecto directamente desde su código fuente.

Requisitos previos

Bifurcación y clonación del repositorio

Para empezar, cree su propia bifurcación del azure/data-api-builder repositorio de GitHub. Esta bifurcación le permite conservar sus propios cambios. Si lo desea, siempre puede abrir una solicitud de incorporación de cambios y sugerir los cambios en el repositorio ascendente.

  1. Vaya a https://github.com/azure/data-api-builder/fork.

  2. Create una bifurcación del repositorio en su propia cuenta o organización. Espere a que se complete la operación de bifurcación antes de continuar.

  3. Abrir un nuevo terminal.

  4. Clone la bifurcación.

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

    Sugerencia

    Como alternativa, puede abrir la bifurcación o el repositorio original como gitHub Codespace.

  5. Compile la src/Azure.DataApiBuilder.sln solución.

    dotnet build src/Azure.DataApiBuilder.sln

Ejecución del motor

La Azure.DataApiBuilder solución incluye varios proyectos. Para ejecutar la herramienta desde el origen, ejecute el Azure.DataApiBuilder.Service proyecto pasando un archivo de configuración.

  1. En el directorio raíz, cree un nuevo archivo denominado dab-config.json.

    Sugerencia

    El archivo .gitignore omite automáticamente los archivos de configuración de DAB.

  2. Agregue el contenido siguiente al archivo de configuración.

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

    Importante

    Se trata de una configuración de ejemplo que supone que tiene un SQL Server disponible en el equipo local. Si no lo hace, puede ejecutar un contenedor de Docker para SQL Server con los datos de ejemplo. Para más información, consulte creación de datos de ejemplo.

  3. Ejecute el proyecto src/Service/Azure.DataApiBuilder.Service.csproj . Use el --ConfigFileName argumento para especificar el archivo de configuración creado en el paso anterior.

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

    Sugerencia

    El motor del generador de API de datos intentará cargar la configuración desde el dab-config.json archivo en la misma carpeta, si está presente. Si no hay ningún dab-config.json archivo, el motor se iniciará de todos modos, pero no podrá servir nada.

Contenido relacionado